Skip to content

Add versioning sections to custom crate READMEs - #26317

Merged
dhruvmanila merged 1 commit into
mainfrom
dhruv/custom-readme-versioning
Jun 24, 2026
Merged

Add versioning sections to custom crate READMEs#26317
dhruvmanila merged 1 commit into
mainfrom
dhruv/custom-readme-versioning

Conversation

@dhruvmanila

@dhruvmanila dhruvmanila commented Jun 24, 2026

Copy link
Copy Markdown
Member

Summary

Adds generated versioning sections to three handwritten crate READMEs.

Follow-up to ruff#26315.

I've skipped ruff_annotate_snippets for now as it's a fork of the original crate.

@dhruvmanila dhruvmanila added the documentation Improvements or additions to documentation label Jun 24, 2026
@@ -19,33 +19,46 @@ There are multiple versions for the different wasm-pack targets. See [here](http
This example uses the wasm-pack web target and is known to work with Vite.

```ts

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.

This code block got formatted because the generator script runs prettier at the end:

# Format all generated READMEs once at the end.
subprocess.run(
["npx", "--yes", f"prettier@{PRETTIER_VERSION}", "--write"]
+ [str(path) for path in generated_paths],
check=True,
stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL,
)

Maybe it should be added to prek instead

@dhruvmanila
dhruvmanila marked this pull request as ready for review June 24, 2026 06:52
@dhruvmanila
dhruvmanila requested a review from MichaReiser as a code owner June 24, 2026 06:52
@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.

@dhruvmanila
dhruvmanila merged commit 0aab61e into main Jun 24, 2026
47 checks passed
@dhruvmanila
dhruvmanila deleted the dhruv/custom-readme-versioning branch June 24, 2026 07:07
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