Improve javadoc of JobInstanceDao#getJobNames method #5043
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clarify that the method returns job names (not job instances) for all jobs that have at least one job instance in the repository. Resolves FIXME comment about ambiguous javadoc description. Signed-off-by: HJC96 <gkswlcjs2@naver.com>
fmbenhassine
changed the title
fmbenhassine
added
pr-for: enhancement
in: documentation
for: backport-to-5.2.x
|
Thank you for the PR! After re-reading that javadoc, I think I misunderstood it at first, but it is actually correct: the content of the job_instance table is actually about all the jobs that have ever been executed (ie that have been executed at least once). But the improvement you suggest is more explicit 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed javadoc for
getJobNames()to clarify it returns job names for which job instances exist.Removed FIXME comment.