Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update Using Python from Rust code to compile #4551

Closed

Conversation

Mossman1215
Copy link

updates the "Using Python from Rust" example in the readme to compile with the current library version

Thank you for contributing to PyO3!

By submitting these contributions you agree for them to be dual-licensed under PyO3's MIT OR Apache-2.0 license.

Please consider adding the following to your pull request:

  • an entry for this PR in newsfragments - see [https://pyo3.rs/main/contributing.html#documenting-changes]
    • or start the PR title with docs: if this is a docs-only change to skip the check
  • docs to all new functions and / or detail in the guide
  • tests for all new or changed functions

PyO3's CI pipeline will check your pull request, thus make sure you have checked the Contributing.md guidelines. To run most of its tests
locally, you can run nox. See nox --list-sessions
for a list of supported actions.

updates the "Using Python from Rust" example in the readme
to compile with the current library version
@davidhewitt
Copy link
Member

Thanks for the PR! So part of the problem here is that we test the in-development PyO3 version against the README, and we have just gone through a big renaming which has created the pain here. The README currently does compile against PyO3 main, but we don't signal this very well.

I'm open to ideas about how we make this process better. It's important we check the README compiles, but checking it against the lastest release rather than main is... harder 😂

@Mossman1215
Copy link
Author

okay I find that as a newcomer unusual so some sort of note on the readme that the quickstart guide assumes you're running the dev branch is fine by me.

@Mossman1215 Mossman1215 deleted the fix-readme-rust-to-python-example branch September 26, 2024 00:58
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