Improve ctx.runfiles and runfiles type docstrings
RELNOTES: None.
PiperOrigin-RevId: 280044117
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/RunfilesApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/RunfilesApi.java
index e43073c..d868e33 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/RunfilesApi.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/RunfilesApi.java
@@ -25,7 +25,11 @@
@SkylarkModule(
name = "runfiles",
category = SkylarkModuleCategory.BUILTIN,
- doc = "An interface for a set of runfiles.")
+ doc =
+ "A container of information regarding a set of files required at runtime execution. This"
+ + " object should be passed via <a href=\"DefaultInfo.html\">DefaultInfo</a> in order"
+ + " to tell the build system about the runfiles needed by the outputs produced by the"
+ + " rule. See <a href=\"../rules.html#runfiles\">runfiles guide</a> for details.")
public interface RunfilesApi extends SkylarkValue {
@SkylarkCallable(
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",
