Use True instead of 1 in the documentation #16165
Closed
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
The parameter is a boolean and because of that True can also be used. From readibility point of view, it is better to use True to know that this is a boolean value and cannot be any arbitrary integer. Having 1 in the documentation makes the users also to use 1 instead of True, that is why the proposal to change it here.
limdor
commented
Aug 25, 2022
| @@ -246,7 +246,7 @@ expanded to Windows style paths (with backslash). | |||
|
|
|||
| /* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(output_to_bindir) --> | |||
| <p> | |||
| If set to 1, this option causes output files to be written into the <code>bin</code> | |||
| If set to True, this option causes output files to be written into the <code>bin</code> | |||
There was a problem hiding this comment.
Note that the documentation is rendered saying default is False and not default is 0
https://bazel.build/reference/be/general#genrule.local
Wyverald
approved these changes
Aug 25, 2022
Wyverald
added
the
awaiting-PR-merge
sgowroji
added
the
team-Documentation
sgowroji
removed
the
awaiting-PR-merge
aiuto
pushed a commit
to aiuto/bazel
that referenced
this pull request
Oct 12, 2022
The parameter is a boolean and because of that True can also be used. From readibility point of view, it is better to use True to know that this is a boolean value and cannot be any arbitrary integer. Having 1 in the documentation makes the users also to use 1 instead of True, that is why the proposal to change it here. Closes bazelbuild#16165. PiperOrigin-RevId: 470425949 Change-Id: I68a776a684d0625571970587a19f0148ebbee79c
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.
The parameter is a boolean and because of that True can also be used.
From readibility point of view, it is better to use True to know that
this is a boolean value and cannot be any arbitrary integer.
Having 1 in the documentation makes the users also to use 1 instead
of True, that is why the proposal to change it here.