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

guide: document #[pyo3(from_py_with)] #1972

Merged
merged 1 commit into from
Nov 9, 2021

Conversation

davidhewitt
Copy link
Member

Closes #1432

@birkenfeld
Copy link
Member

There's a lot more here than the PR title suggests :)

@davidhewitt
Copy link
Member Author

Heh sorry, I was a bit short of time when finishing up and posting this PR!

To describe what's going on, really the only new content is indeed a description for #[pyo3(from_py_with)].

The rest of the changes is just rearrangements to function.md which I thought made sense to support this.

Here's a full list for reviewers:

  • Expanded the chapter opening with some links to the sub-content of the chapter.
  • Moved the description of #[pyo3(text_signature = "...")] for classes and methods to class.md.
  • Moved #[pyfn] docs to the bottom of function.md (and made description of #[pyfn] warn that I'd like to remove it).
  • Moved the other #[pyo3(<option> = <value>)] bits into the bullets under "Function options".

Copy link
Member

@mejrs mejrs left a comment

Choose a reason for hiding this comment

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

LGTM

@davidhewitt davidhewitt merged commit 5c828b6 into PyO3:main Nov 9, 2021
@davidhewitt davidhewitt deleted the document-from-py-with branch November 9, 2021 20:42
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.

Guide: #[pyo3(name = "")] and #[pyo3(from_py_with = "")]
3 participants