Skip to content

Update ruff_python_parser README for crates.io - #26315

Merged
dhruvmanila merged 2 commits into
mainfrom
dhruv/parser-readme-versioning
Jun 24, 2026
Merged

Update ruff_python_parser README for crates.io#26315
dhruvmanila merged 2 commits into
mainfrom
dhruv/parser-readme-versioning

Conversation

@dhruvmanila

@dhruvmanila dhruvmanila commented Jun 24, 2026

Copy link
Copy Markdown
Member

Summary

This PR updates the parser README to:

  1. Link the parser README's AST reference to the published ruff_python_ast crate
  2. Remove the obsolete "Python version support" section now that version specific syntax errors are implemented

Additionally, I've also updated the README generator to add a "Versioning" section while preserving the rest of the handwritten README and updated the generator to refresh marker-delimited versioning sections. Maybe this is not worth doing, let me know if that's the case.

Review

  • 5a4145a - updates the README manually as mentioned in (1) and (2) above
  • dcb5925 - updates the README generator to add the versioning section

Test plan

Here's the Rendered README for preview.

Ran uv run --script scripts/generate-crate-readmes.py twice and verified idempotent output

@dhruvmanila dhruvmanila changed the title Update ruff_python_parser README for crates.io Update ruff_python_parser README for crates.io Jun 24, 2026
@dhruvmanila dhruvmanila added the documentation Improvements or additions to documentation label Jun 24, 2026
@dhruvmanila
dhruvmanila marked this pull request as ready for review June 24, 2026 03:52
@dhruvmanila
dhruvmanila requested a review from MichaReiser as a code owner June 24, 2026 03:52
@dhruvmanila

Copy link
Copy Markdown
Member Author

The formatter also has a custom README, if we decide to go forward with adding the versioning section for the parser, I can follow-up with adding this section to the formatter and other manually written READMEs as well.

@astral-sh-bot

astral-sh-bot Bot commented Jun 24, 2026

Copy link
Copy Markdown

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Formatter (stable)

✅ ecosystem check detected no format changes.

Formatter (preview)

✅ ecosystem check detected no format changes.


## Versioning

<!-- BEGIN GENERATED CRATE VERSIONING -->

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just so that I understand the change. The EGIN GENERATED CRATE VERSIONING support in generate-crate-readmes is needed for crates that contain other content than just the versioning blurb.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes. If the README already exists with some content, the script didn't do anything. But now it will add the blurb if this "BEGIN ...", "END ..." comment pair exist.

@MichaReiser MichaReiser left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you

@dhruvmanila
dhruvmanila merged commit c24ded8 into main Jun 24, 2026
54 checks passed
@dhruvmanila
dhruvmanila deleted the dhruv/parser-readme-versioning branch June 24, 2026 06:37
dhruvmanila added a commit that referenced this pull request Jun 24, 2026
## Summary

Adds generated versioning sections to three handwritten crate READMEs.

Follow-up to [ruff#26315](#26315).

I've skipped `ruff_annotate_snippets` for now as it's a fork of the
original crate.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants