Update ruff_python_parser README for crates.io - #26315
Conversation
ruff_python_parser README for crates.io
|
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. |
|
|
|
||
| ## Versioning | ||
|
|
||
| <!-- BEGIN GENERATED CRATE VERSIONING --> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
## 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.
Summary
This PR updates the parser README to:
ruff_python_astcrateAdditionally, 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
Test plan
Here's the Rendered README for preview.
Ran
uv run --script scripts/generate-crate-readmes.pytwice and verified idempotent output