docs(gazelle): Use definition lists instead of bullets for Gazelle docs#3154
Merged
dougthor42 merged 3 commits intobazel-contrib:mainfrom Aug 8, 2025
Merged
Conversation
Primary updates:
+ Use Definition List
+ Move the annotation/directive description to the definition line
Secondary updates:
+ Add missing directive arguments. For example, `#
gazelle:python_extension` becomes `# gazelle:python_extension value`.
+ Address WIP lines for "allowed values"
+ Link things with `{term}`.
Fixes bazel-contrib#3142.
aignas
approved these changes
Aug 8, 2025
Collaborator
|
Consider adding a note in the CHANGELOG about the |
+ Add note about Gazelle docs move + Fix missing backticks + Fix EOL whitespace
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Primary updates:
Secondary updates:
# gazelle:python_extensionbecomes# gazelle:python_extension value.{term}.Fixes #3142.