Skip to content

docs: don't warn about starlark_doc_extract output #27302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

docs: don't warn about starlark_doc_extract output #27302

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c373e9d
docs: don't warn about starlark_doc_extract output
alexeagle Oct 16, 2025
e6ebea7
Update StarlarkDocExtractRule.java
alexeagle Oct 17, 2025
7dc5e50
Update StarlarkDocExtractRule.java
alexeagle Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ...n/java/com/google/devtools/build/lib/rules/starlarkdocextract/StarlarkDocExtractRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,9 @@ public Metadata getMetadata() {

${IMPLICIT_OUTPUTS}

<p>Warning: the output format of this rule is not guaranteed to be stable. It is intended mainly for
internal use by <a href="https://github.com/bazelbuild/stardoc">Stardoc</a>.
Note: the exact output of this rule is not a stable public API.
For example, the set of natively-defined common rule attributes and their docstrings may change even with minor Bazel releases.
For this reason, documentation generated for user-defined rules is not stable across Bazel releases,
so we suggest taking care that any "golden" tests based on outputs of this rule are only run with a single Bazel version.

<!-- #END_BLAZE_RULE -->*/
Loading