Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SlicedProgressMonitor: fix javadoc #430

Closed
wants to merge 1 commit into from

Conversation

jukzi
Copy link
Contributor

@jukzi jukzi commented Dec 12, 2023

No description provided.

Copy link

Test Results

     24 files  ±0       24 suites  ±0   10m 53s ⏱️ -34s
2 150 tests ±0  2 105 ✔️ ±0  45 💤 ±0  0 ±0 
2 194 runs  ±0  2 149 ✔️ ±0  45 💤 ±0  0 ±0 

Results for commit f74aa34. ± Comparison against base commit 9bb51e4.

@jukzi
Copy link
Contributor Author

jukzi commented Jan 9, 2024

there are only unrelated TCK fails, please review/submit

* default implementation of a {@link SlicedProgressMonitor} that synchronizes
* on the given monitor to report work
* default implementation for
* {@link org.eclipse.core.runtime.IProgressMonitor#slice(int)} that
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a public class that can be used in other context as well so I don't think its correct to say it is for THAT implementation of this specific method...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at the moment the javadoc says SlicedProgressMonitor implments SlicedProgressMonitor - which is a nobrainer

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well in fact it says

default implementation of a SlicedProgressMonitor that ...

you can remove the link if you want and maybe reword it as

implementation of a ProgressMonitor that handles sliced work by ...

... or similar, but it can be used by anyone or any implementation and even can be extended an is not only for IProgressMonitor#slice(int) default impl.

@jukzi jukzi closed this Jan 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants