Skip to content

Documentation: fix the update_readme script#3186

Open
ManonMarchand wants to merge 2 commits into
PyO3:mainfrom
ManonMarchand:document-platforms
Open

Documentation: fix the update_readme script#3186
ManonMarchand wants to merge 2 commits into
PyO3:mainfrom
ManonMarchand:document-platforms

Conversation

@ManonMarchand
Copy link
Copy Markdown
Contributor

@ManonMarchand ManonMarchand commented May 13, 2026

Hello maturin maintainers 👋

This PR does two things:

fixes the script update readme.py

The regexp was failing in two cases:

  • if the documentation had bash\nUsage: instead of Usage:
  • if the command had a dash (as in generate-ci)

Now that it works I ran it and the documentation is up to date again.

adds a precision in generate-ci doc

Took me some time to understand how to set the platforms from the pyproject file. Thought I'd add a hint.

@messense
Copy link
Copy Markdown
Member

Thanks for the PR, tests are failing.

@ManonMarchand
Copy link
Copy Markdown
Contributor Author

Yes, I'll have time to fix the tests on monday. I'm switching to draft for now 🙂

@ManonMarchand ManonMarchand marked this pull request as draft May 14, 2026 12:57
@ManonMarchand ManonMarchand force-pushed the document-platforms branch 2 times, most recently from 7bcc410 to 0433df6 Compare May 19, 2026 13:35
@ManonMarchand ManonMarchand marked this pull request as ready for review May 19, 2026 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants