Improve documentation for select() (bazelbuild#14769)

* 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 bazelbuild#14458. PiperOrigin-RevId: 420129541 (cherry picked from commit 67a133b) Co-authored-by: Fabian Meumertzheim <[email protected]>
axivion · Feb 9, 2022 · 58ecec3 · 58ecec3
1 parent 0df1851
commit 58ecec3
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/main/java/com/google/devtools/build/lib/packages/StarlarkLibrary.java b/src/main/java/com/google/devtools/build/lib/packages/StarlarkLibrary.java
@@ -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 = "''",