Clarify that flags are bitwise, and that FlagDeleted is non-zero. #43
Conversation
This file contains 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 commit has no functional change, it only clarifies the documentation of header flags. Specifically: - Add a missing doc comment to the exported Flag type declaration. - Consolidate the declaration of FlagDeleted so it is more obvious to the reader in godoc that it is non-zero. This also ensures that if we add more enumerators later, they will shift correctly. Signed-off-by: M. J. Fromberger <[email protected]>
mcarmonaa
approved these changes
Jun 6, 2019
jfontan
approved these changes
Jun 10, 2019
|
Ping @mcuadros @smola @ajnavarro, this is a minor documentation cleanup, any objections if I merge it? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 commit has no functional change, it only clarifies the documentation of
header flags. Specifically:
Add a missing doc comment to the exported Flag type declaration.
Consolidate the declaration of FlagDeleted so it is more obvious to the
reader in godoc that it is non-zero. This also ensures that if we add more
enumerators later, they will shift correctly.