Skip to content

Conversation

@dougthor42
Copy link
Collaborator

Part of #3082

3rd of probably 5 PRs.

  • Migrate annotations docs from gazelle/README.md to gazelle/docs/annotations.md
  • Switch from table-based summary to bulleted lists
    • This will be much easier to maintain going forward.
  • Mechanical updates:
    • Wrap at ~80 chars
    • Use MyST directives and roles.

@dougthor42 dougthor42 marked this pull request as ready for review August 4, 2025 04:33
@dougthor42 dougthor42 requested a review from aignas as a code owner August 4, 2025 04:33
{gh-pr}`879`), Gazelle will include a `:conftest` dependency to a
{bzl:obj}`py_test` target that is in the same directory as `conftest.py`.

[rules-python-0.14.0]: https://github.com/bazel-contrib/rules_python/releases/tag/0.14.0
Copy link
Collaborator

Choose a reason for hiding this comment

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

Consider using versionadded directive.

See https://github.com/search?q=repo%3Abazel-contrib%2Frules_python+versionadded&type=code for examples

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah, I'd forgotten about that directive!

I updated Added in PR 3080 to use it but I opted to keep this one as-is because

  1. I wanted to keep both the version and PR links and
  2. I thought that it would be confusing to see "Added in version 0.14.0" under the include_pytest_conftest section.

@dougthor42 dougthor42 added this pull request to the merge queue Aug 4, 2025
Merged via the queue into bazel-contrib:main with commit 3c88a5b Aug 4, 2025
3 checks passed
@dougthor42 dougthor42 deleted the u/dthor/gazelle-refactor-docs-pt3-annotations branch August 4, 2025 17:08
@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