diff options
author | 2015-10-08 12:54:48 +0000 | |
---|---|---|
committer | 2015-10-09 14:39:51 +0000 | |
commit | 90178f4471d67799b2dbaa07f19809d1b00b91d2 (patch) | |
tree | 61e5414a86e1c7309958f367b675524105e4b443 /src/main/java/com/google/devtools | |
parent | cffd001a0ecf1dd5a0d058d8d285d21fb021dbcd (diff) |
Update "print" documentation (we discourage its use).
--
MOS_MIGRATED_REVID=104954735
Diffstat (limited to 'src/main/java/com/google/devtools')
-rw-r--r-- | src/main/java/com/google/devtools/build/lib/syntax/MethodLibrary.java | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/syntax/MethodLibrary.java b/src/main/java/com/google/devtools/build/lib/syntax/MethodLibrary.java index d9f7bb10b5..9f1e80fe1e 100644 --- a/src/main/java/com/google/devtools/build/lib/syntax/MethodLibrary.java +++ b/src/main/java/com/google/devtools/build/lib/syntax/MethodLibrary.java @@ -1458,7 +1458,9 @@ public class MethodLibrary { }; @SkylarkSignature(name = "print", returnType = Runtime.NoneType.class, - doc = "Prints <code>msg</code> to the console.", + doc = "Prints a warning with the text <code>msg</code>. It can be used for debugging or " + + "for transition (before changing to an error). In other cases, warnings are " + + "discouraged.", optionalNamedOnly = { @Param(name = "sep", type = String.class, defaultValue = "' '", doc = "The separator string between the objects, default is space (\" \").")}, |