commit 354a6fef5e47ec305551ddec70d94b79430085ab
author cparsons <cparsons@google.com> Tue Nov 12 13:41:06 2019 -0800
committer Copybara-Service <copybara-worker@google.com> Tue Nov 12 13:42:00 2019 -0800
tree 304d392df2ffb27ea71bd608424633494d22f7cd
parent 942e1c4a374a0ece069515d409e7acf9dac508d0

Improve ctx.runfiles and runfiles type docstrings

RELNOTES: None.
PiperOrigin-RevId: 280044117

src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkRuleContextApi.java

diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkRuleContextApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkRuleContextApi.java
index 8f78fd7..9fac798 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkRuleContextApi.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkRuleContextApi.java
@@ -870,7 +870,9 @@
             defaultValue = "False",
             named = true,
             doc =
-                "Whether to collect the data "
+                "<b>Use of this parameter is not recommended. See "
+                    + "<a href=\"../rules.html#runfiles\">runfiles guide</a></b>. "
+                    + "<p>Whether to collect the data "
                     + "runfiles from the dependencies in srcs, data and deps attributes."),
         @Param(
             name = "collect_default",
@@ -878,7 +880,9 @@
             defaultValue = "False",
             named = true,
             doc =
-                "Whether to collect the default "
+                "<b>Use of this parameter is not recommended. See "
+                    + "<a href=\"../rules.html#runfiles\">runfiles guide</a></b>. "
+                    + "<p>Whether to collect the default "
                     + "runfiles from the dependencies in srcs, data and deps attributes."),
         @Param(
             name = "symlinks",