aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib
diff options
context:
space:
mode:
authorGravatar vladmos <vladmos@google.com>2018-01-22 10:14:06 -0800
committerGravatar Copybara-Service <copybara-piper@google.com>2018-01-22 10:16:07 -0800
commit772d958f1577f1697a1112ffbddc23898c11a48b (patch)
tree259c352d16d02322722e384d41e2880eb1b8abc2 /src/main/java/com/google/devtools/build/lib
parent65797d43f1ae31b8150d36734d3d07db3369e1c8 (diff)
Improve documentation for the select function
PiperOrigin-RevId: 182796843
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib')
-rw-r--r--src/main/java/com/google/devtools/build/lib/syntax/BazelLibrary.java5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/syntax/BazelLibrary.java b/src/main/java/com/google/devtools/build/lib/syntax/BazelLibrary.java
index 6de5f3e186..15b35dfaf3 100644
--- a/src/main/java/com/google/devtools/build/lib/syntax/BazelLibrary.java
+++ b/src/main/java/com/google/devtools/build/lib/syntax/BazelLibrary.java
@@ -238,7 +238,10 @@ public class BazelLibrary {
*/
@SkylarkSignature(
name = "select",
- doc = "Creates a select from the dict parameter, usable for setting configurable attributes.",
+ doc =
+ "<code>select()</code> is the helper function that makes a rule attribute "
+ + "<a href=\"$BE_ROOT/common-definitions.html#configurable-attributes\">configurable</a>. "
+ + "See <a href=\"$BE_ROOT/functions.html#select\">build encyclopedia</a> for details.",
parameters = {
@Param(name = "x", type = SkylarkDict.class, doc = "The parameter to convert."),
@Param(