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: use versioned links from docs to guide #4331

Merged
merged 2 commits into from
Jul 10, 2024

Conversation

davidhewitt
Copy link
Member

This PR changes links in docs to use env!("CARGO_PKG_VERSION") to fill in the current PyO3 version instead of just pointing at https://pyo3.rs/latest.

I think this is a nice UX change for users looking at older versions, who will be able to use stable links that might otherwise break when we make adjustments to the guide.

@davidhewitt
Copy link
Member Author

(It also fixes the build-guide failure after I introduced such a link in #4325, so we should either merge this or I should change those links to point at latest.)

@@ -1,10 +1,10 @@
error: #[pyclass] cannot have generic parameters. For an explanation, see https://pyo3.rs/latest/class.html#no-generic-parameters
error: #[pyclass] cannot have generic parameters. For an explanation, see https://pyo3.rs/v0.23.0-dev/class.html#no-generic-parameters
Copy link
Contributor

Choose a reason for hiding this comment

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

Will we need to update this every release? Or will this just become v0.23.0 when that's released and then not change again?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we'll need to update this every release, which is a touch annoying but not the end of the world. I'm prepared to just add it to the usual release prep PR ceremony 😊

@davidhewitt davidhewitt added this pull request to the merge queue Jul 10, 2024
Merged via the queue into PyO3:main with commit 32b6a1a Jul 10, 2024
40 of 41 checks passed
@davidhewitt davidhewitt deleted the guide-version-links branch July 10, 2024 14:18
davidhewitt added a commit that referenced this pull request Jul 10, 2024
* use versioned links from docs to guide

* use standard python version in `guide-build` ci job
davidhewitt added a commit that referenced this pull request Jul 16, 2024
* use versioned links from docs to guide

* use standard python version in `guide-build` ci job
davidhewitt added a commit that referenced this pull request Jul 17, 2024
* use versioned links from docs to guide

* use standard python version in `guide-build` ci job
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