Make code self explanatory #292
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
This PR does NOT make any semantic change, it literally just makes existing code self-explanatory. Just to avoid that in 2 years another of us looks at this and become puzzled what in case of "last modified" means 0L, and why a method returns 1L, etc. This class is fully covered with self explanatory UTs as well. No JIRA created either.
gnodet
approved these changes
May 26, 2023
Contributor
gnodet
left a comment
gnodet
left a comment
There was a problem hiding this comment.
Looks good, though the value 1 is still a magic value because it's never read and it works only because it's always less than any clock timestamp...
michael-o
approved these changes
May 26, 2023
Member
Author
|
Again, I did not change anything. But spent so much time figure out the logic behind all this and "why 1???", so intent is really just to add constants that are "decorated" with javadoc explaining their meaning. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR does NOT make any semantic change, it literally just makes existing code self-explanatory.
Just to avoid that in 2 years another of us looks at this and become puzzled what in case of "last modified" means 0L, and why a method returns 1L, etc.
This class is fully covered with self explanatory UTs as well.
No JIRA created either.