Update docs for raw FFI use#4665
Merged
Merged
Conversation
davidhewitt
reviewed
Oct 29, 2024
davidhewitt
left a comment
Member
There was a problem hiding this comment.
Thanks, this is a good improvement. I spotted few small additional refinements:
Contributor
Author
|
I think Not sure how to work around or ignore that. |
Contributor
Author
Removed the links, we can always add better cross-referencing later. |
davidhewitt
approved these changes
Oct 30, 2024
davidhewitt
left a comment
Member
There was a problem hiding this comment.
Fair enough, sorry for the slow reply by me. The check-guide job in the noxfile has some mapping for various locally-built files; probably we could have added to that.
This looks good to me, thanks 👍
This file contains hidden or 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
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 noticed some issues in these docs while working on #4588. Opening this PR so that one doesn't get bogged down.
examplesfolder in thepyo3-fficrate.string-sumexample from theexamplesfolder. The content that is there now is substantially out of sync from the content in theexamplesfolder and that seemed wrong to me.sequentialexample and mention multi-phase initialization in the top-level pyo3-ffi docs.