Skip to content

Commit

Permalink
Improve documentation for select() (#14769)
Browse files Browse the repository at this point in the history
* Reference documentation that explains when to use Label rather than a label string.
* Remove mention of constraint_settings as they can't be used as select keys.

Closes #14458.

PiperOrigin-RevId: 420129541
(cherry picked from commit 67a133b)

Co-authored-by: Fabian Meumertzheim <fabian@meumertzhe.im>
  • Loading branch information
brentleyjones and fmeum authored Feb 9, 2022
1 parent 0df1851 commit 58ecec3
Showing 1 changed file with 3 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -332,8 +332,9 @@ public Depset depset(
doc =
"A dict that maps configuration conditions to values. Each key is a "
+ "<a href=\"$BE_ROOT/../skylark/lib/Label.html\">Label</a> or a label string"
+ " that identifies a config_setting, constraint_setting, or constraint_value"
+ " instance."),
+ " that identifies a config_setting or constraint_value instance. See the"
+ " <a href=\"$BE_ROOT/../skylark/macros.html#label-resolution-in-macros\">"
+ "documentation on macros</a> for when to use a Label instead of a string."),
@Param(
name = "no_match_error",
defaultValue = "''",
Expand Down

0 comments on commit 58ecec3

Please sign in to comment.