docs: document when Bound::new returns Err - #6457
Open
SatvikMishra08 wants to merge 1 commit into
Open
SatvikMishra08 wants to merge 1 commit into
SatvikMishra08 wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
Summary
Bound::newreturnsPyResult, but rustdoc did not explain when it can beErr.Adds an
# Errorssection documenting the usual failure modes from thePyClassInitializer/create_class_objectpath:tp_new→PyTypeError("base type without tp_new")tp_new/ allocation returning null →PyErr::fetch(commonlyMemoryErroror another exception raised during init)Keeps the existing
# Examplesblock intact.Fixes #5485
Test plan
cargo doc -p pyo3 --no-deps(or docs CI) renders# ErrorsonBound::newwithout broken intra-doc links