Normalize repository starlark API docs #22762
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
team-ExternalDeps
meteorcloudy
approved these changes
Jul 4, 2024
meteorcloudy
added
awaiting-PR-merge
github-actions
bot
removed
the
awaiting-PR-merge
fmeum
pushed a commit
to fmeum/bazel
that referenced
this pull request
Aug 22, 2024
Now that Bazel built with JDK21, Starlark builtin documentation can be made more readable in source (and easier to author, since less escaping is required). This PR refactors the repository starlark API under `src/main/java/com/google/devtools/build/lib/bazel/repository/starlark/` to use multi-line text blocks. Minor edits have also been made to some documentation (replacing unprocessed back-ticks with HTML `code` tags, adding `code` tags where I think it makes sense, capitalization, punctuation). Stats wise (excluding `test` directory) this covers; - 34 of 1101 `@StarlarkMethod(...)` (5 of 170 files) - 5 of 233 `@StarlarkBuiltin(...)` (5 of 221 files) Closes bazelbuild#22762. PiperOrigin-RevId: 650649974 Change-Id: I3002b8d4bccbe1d11aa6aff184b448eb1f280ba4
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Now that Bazel built with JDK21, Starlark builtin documentation can be made more readable in source (and easier to author, since less escaping is required).
This PR refactors the repository starlark API under
src/main/java/com/google/devtools/build/lib/bazel/repository/starlark/to use multi-line text blocks. Minor edits have also been made to some documentation (replacing unprocessed back-ticks with HTMLcodetags, addingcodetags where I think it makes sense, capitalization, punctuation).Stats wise (excluding
testdirectory) this covers;@StarlarkMethod(...)(5 of 170 files)@StarlarkBuiltin(...)(5 of 221 files)