Document ctx.info_path and ctx.version_path.
workspace_status_command is a supported interface, so these should be documented too.
RELNOTES:
ctx.info_path and ctx.version_path for `--workspace_status_command` are now documented in the Starlark API reference.
@@ -461,19 +461,21 @@ public interface StarlarkRuleContextApi<ConstraintValueT extends ConstraintValue
@StarlarkMethod(
name = "info_file",
structField = true,
- documented = false,
+ documented = true,
doc =
"Returns the file that is used to hold the non-volatile workspace status for the "
- + "current build request.")
+ + "current build request. See documentation for --workspace_status_command "
+ + "for more information.")
FileApi getStableWorkspaceStatus() throws InterruptedException, EvalException;
@StarlarkMethod(
name = "version_file",
structField = true,
- documented = false,
+ documented = true,
doc =
"Returns the file that is used to hold the volatile workspace status for the "
- + "current build request.")
+ + "current build request. See documentation for --workspace_status_command "
+ + "for more information.")
FileApi getVolatileWorkspaceStatus() throws InterruptedException, EvalException;
@StarlarkMethod(
