aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar tomlu <tomlu@google.com>2017-09-22 19:28:09 -0400
committerGravatar John Cater <jcater@google.com>2017-09-25 09:38:56 -0400
commitfefccdbfa28d8460c74b33dfc29a8aabc4d6a488 (patch)
treedbc1751cede2e320c32e78d96dbf87f80e1d9a92
parent529d7ea29704cd869ab3eff9683b5775cc9127f3 (diff)
Fix and improve context.args.add documentation.
RELNOTES: None PiperOrigin-RevId: 169753517
-rw-r--r--src/main/java/com/google/devtools/build/lib/analysis/skylark/SkylarkActionFactory.java6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/analysis/skylark/SkylarkActionFactory.java b/src/main/java/com/google/devtools/build/lib/analysis/skylark/SkylarkActionFactory.java
index eb4de9314b..5befedce89 100644
--- a/src/main/java/com/google/devtools/build/lib/analysis/skylark/SkylarkActionFactory.java
+++ b/src/main/java/com/google/devtools/build/lib/analysis/skylark/SkylarkActionFactory.java
@@ -858,7 +858,7 @@ public class SkylarkActionFactory implements SkylarkValue {
+ "args.add(\"--bar\")\n"
+ "args.add(bar_deps, join_with=\",\")\n"
+ "ctx.run(\n"
- + " arguments = args,\n"
+ + " arguments = [args],\n"
+ " ...\n"
+ ")\n"
+ "# Expands to [\n"
@@ -935,7 +935,9 @@ public class SkylarkActionFactory implements SkylarkValue {
positional = false,
defaultValue = "None",
noneable = true,
- doc = "The passed objects are passed through a map function. "
+ doc =
+ "The passed objects are passed through a map function. "
+ + "For vector args the function is given a list and is expected to return a list."
)
},
useLocation = true