docs(cuda.core): document PinnedMemoryResource.allocate parameters - #2713
Open
fedonman wants to merge 1 commit into
Open
docs(cuda.core): document PinnedMemoryResource.allocate parameters#2713fedonman wants to merge 1 commit into
fedonman wants to merge 1 commit into
Conversation
The override's one-line docstring is what autodoc renders, so the generated page for the public class documented neither the required keyword-only stream argument nor the return value, and never mentioned the RuntimeError raised when the device does not support the requested host memory pool. Give the override the full numpydoc body. The .pyi stub is regenerated by the stubgen-pyx-cuda-core pre-commit hook. Closes NVIDIA#2712. Signed-off-by: Vyron Vasileiadis <hi@fedonman.com>
Contributor
github-actions
Bot
added
the
cuda.core
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.
Description
closes #2712
PinnedMemoryResource.allocateoverrides the inherited method with a one-line docstring, and that one line is all autodoc has to render, so the generated page for the public class documented neither the required keyword-onlystreamargument nor the return value, and never mentioned theRuntimeErrorraised when the device does not support the requested host memory pool. This gives the override the full numpydoc body, including aRaisessection for that error. The.pyistub is regenerated by thestubgen-pyx-cuda-corepre-commit hook rather than hand-edited.Docstring-only change, so there is no new test. What the class now renders, and the existing suite:
No release note: the one-line docstring landed in #2487, after the
cuda-core-v1.1.1tag, so nothing user-visible changed since the last release.Checklist