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.

Sign up for GitHub

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

Fix pyproto documentation. #2578

Merged
merged 2 commits into from
Aug 22, 2022
Merged

Fix pyproto documentation. #2578

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db8b55a
pyproto is no longer enabled by default
Aug 21, 2022
ae50da1
Mention a concrete pyo3 version
Aug 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@
//! The following features are turned on by default:
//! - `macros`: Enables various macros, including all the attribute macros excluding the deprecated
//! `#[pyproto]` attribute.
//! - `pyproto`: Adds the deprecated `#[pyproto]` attribute macro. Likely to become optional and
//! then removed in the future.
//!
//! ## Optional feature flags
//!
Expand All @@ -89,6 +87,8 @@
//! - `multiple-pymethods`: Enables the use of multiple [`#[pymethods]`](macro@crate::pymethods)
//! blocks per [`#[pyclass]`](macro@crate::pyclass). This adds a dependency on the [inventory]
//! crate, which is not supported on all platforms.
//! - `pyproto`: Enables the deprecated `#[pyproto]` attribute macro. This will be removed in a
//! future release.
Copy link
Member Author

Choose a reason for hiding this comment

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

Do we want to mention a concrete version? 0.18 perhaps?

Copy link
Member

Choose a reason for hiding this comment

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

I think it's fine to say 0.18 here 👍 (I'm already planning to have a bonfire PR as soon as 0.17 is out the door xD)

//!
//! The following features enable interactions with other crates in the Rust ecosystem:
//! - [`anyhow`]: Enables a conversion from [anyhow]’s [`Error`][anyhow_error] type to [`PyErr`].
Expand Down