rust: fix crate-doc example (pyde_return is under raw::) - #26
Merged
Conversation
The Usage example called pyde_host::pyde_return(...), but pyde_return is declared inside `pub mod raw` (the low-level escape hatch), so the path is pyde_host::raw::pyde_return. The block is `ignore`d so it never broke a build, but it would send anyone copy-pasting it to an unresolved path.
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
1 participant
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.
The crate-level
## Usagedoc example callspyde_host::pyde_return(...), butpyde_returnis declared insidepub mod raw— the correct path ispyde_host::raw::pyde_return. The block isignored so it never failed a doctest, but it misdirects anyone copy-pasting it. One-line doc fix.