diff options
| author |  Laurent Le Brun <laurentlb@google.com> | 2015-10-26 14:43:00 +0000 |
|---|---|---|
| committer |  Florian Weikert <fwe@google.com> | 2015-10-27 11:47:12 +0000 |
| commit | fc9b6e628aacfdfaae7b6048dcbbed0df0bba8ec (patch) | |
| tree | b3a584a5341d3c79f6db2775edb89e54dba2dc21 /src | |
| parent | ee51bdd08ab3cc883f5e5e90c6f8ecadf8ba1ebb (diff) | |
Clarify documentation about 'native' module.
--
MOS_MIGRATED_REVID=106299058
Diffstat (limited to 'src')
| -rw-r--r-- | src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java b/src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java index cb30847aee..377464e930 100644 --- a/src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java +++ b/src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java @@ -31,9 +31,11 @@ import com.google.devtools.build.lib.syntax.Type.ConversionException; */ @SkylarkModule(name = "native", namespace = true, doc = "A built-in module to support native rules and other package helper functions. " - + "All native rules appear as functions in this module. Note that the native module is only " - + "available in the loading phase (i.e. for macros, not for rule implementations).<br/>" - + "Extra helper functions:") + + "All native rules appear as functions in this module, e.g. <code>native.cc_library</code>. " + + "Note that the native module is only available in the loading phase " + + "(i.e. for macros, not for rule implementations). Attributes will ignore <code>None</code> " + + "values, and treat them as if the attribute was unset.<br>" + + "The following functions are also available:") public class SkylarkNativeModule { // TODO(bazel-team): shouldn't we return a SkylarkList instead? |