Skip to content

Conversation

@dougthor42
Copy link
Collaborator

Part of #3082

4th of probably 5 PRs.

  • Migrate directive docs from gazelle/README.md to gazelle/docs/directives.md
  • Switch from table-based summary to bulleted lists
    • This will be much easier to maintain going forward.
  • Add dedicated sections for each directive
    • Though not filled out yet. I do plan on filling them out later, I just can't say when.
  • Mechanical updates:
    • Wrap at ~80 chars
    • Use MyST directives and roles.

@dougthor42 dougthor42 marked this pull request as ready for review August 5, 2025 03:34
@dougthor42 dougthor42 requested a review from aignas as a code owner August 5, 2025 03:34
Copy link
Collaborator

@aignas aignas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM


The Python-specific directives are:

* [`# gazelle:python_extension`](#python-extension)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: have you considered using definition lists here?

I think typographically this would look better?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look into it 👍 #3142.

@dougthor42 dougthor42 added this pull request to the merge queue Aug 5, 2025
Merged via the queue into bazel-contrib:main with commit 7682924 Aug 5, 2025
3 checks passed
@dougthor42 dougthor42 deleted the u/dthor/gazelle-refactor-docs-pt4-directives branch August 5, 2025 19:22
@dougthor42 dougthor42 added type: documentation gazelle Gazelle plugin related issues labels Aug 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gazelle Gazelle plugin related issues type: documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants