docs: pile of tweaks and additions #2580
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidhewitt
force-pushed
the
docs-bonanza
branch
from
1274266
to
1fc85f9
Compare
mejrs
reviewed
Aug 22, 2022
guide/src/function.md
Outdated
Comment on lines
216
to
217
| - Concrete functions, e.g. `fn foo()`: add `#[pyfunction]` and then use [`wrap_pyfunction!`] to get the corresponding [`PyCFunction`]. | ||
| - Dynamic functions, e.g. `foo: fn()` either: |
There was a problem hiding this comment.
What about "named" and "anonymous/closures" versus "concrete" and "dynamic"? I don't think many people are familiar with those terms.
guide/src/function/error_handling.md
Outdated
|
|
||
| The Rust compiler will not permit implementation of traits for types outside of the crate where the type is defined. (This is known as the "orphan rule".) | ||
|
|
||
| Given a type `OtherError` which is defined in thirdparty code, there are two main strategies available to integrate it with PyO3: |
There was a problem hiding this comment.
This should be third-party or third party? (same for the other usages). I'm not a native english speaker so I'm not sure 馃樅
There was a problem hiding this comment.
Good catch! I think third-party is the adjective form and third party the noun from looking at https://dictionary.cambridge.org/dictionary/english/third-party, so I will use third-party here.
davidhewitt
force-pushed
the
docs-bonanza
branch
from
1d93ded
to
f753790
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was stuck on the train this afternoon with barely a working internet connection, so what better thing to do than close a whole pile of docs issues 馃槃
I tried to land everything (mostly) as separate commits. Changes included:
::pyo3from guide samples (given that's not quite what the macro expands to anyway!)Python::with_gil聽#2495__richcmp__makes object unhashable聽#2122All reviews welcome, I'll probably merge this on Tuesday if I haven't heard anything so that it can be part of the published 0.17 guide. Figure even if it's not perfect it's probably better than not including in the release :)