Skip to content

Commit

Permalink
Use True instead of 1 in the documentation
Browse files Browse the repository at this point in the history
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
  • Loading branch information
limdor authored and copybara-github committed Aug 27, 2022
1 parent 3ccf9a9 commit 9ac7e71
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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>
directory instead of the <code>genfiles</code> directory.
</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
Expand All @@ -259,7 +259,7 @@ expanded to Windows style paths (with backslash).

/* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(local) -->
<p>
If set to 1, this option forces this <code>genrule</code> to run using the "local"
If set to True, this option forces this <code>genrule</code> to run using the "local"
strategy, which means no remote execution, no sandboxing, no persistent workers.
</p>
<p>
Expand Down

0 comments on commit 9ac7e71

Please sign in to comment.