-
Notifications
You must be signed in to change notification settings - Fork 321
test(core): add cuda.core.__all__ vs public docs consistency check #2347
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mdboom
merged 18 commits into
NVIDIA:main
from
aryanputta:test/api-docs-consistency-2326
Jul 29, 2026
Merged
Changes from 10 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
1fc21b2
test(core): add cuda.core.__all__ vs public docs consistency check
aryanputta 37cd68f
test(core): land cuda.core.__all__ and extend docs check to public su…
aryanputta 75e719d
test(core): parse API docs with docutils
aryanputta f38051c
Update content to pass current tests
mdboom 7b1be3e
Add docutils dependency to pyproject.toml
mdboom 1438c20
Simplify checks. No longer make sure that everything documented is p…
mdboom 39f9843
test(core): document intentional scope limits of api docs consistency…
aryanputta c09dd0c
Reorganize __all__
mdboom 41003b8
Fix doc reference
mdboom 5a4a178
Merge branch 'main' into test/api-docs-consistency-2326
mdboom b69022b
Address findings in PR
mdboom 123ab66
Merge remote-tracking branch 'upstream/main' into test/api-docs-consi…
mdboom c6429f0
Merge branch 'main' into test/api-docs-consistency-2326
mdboom 30bf6fc
Fix tests and make __all__ construction consistent
mdboom 93e6d48
Merge branch 'test/api-docs-consistency-2326' of github.com:aryanputt…
mdboom 565479b
Merge remote-tracking branch 'upstream/main' into test/api-docs-consi…
mdboom f768d40
test(core): drop IPC types from _memory package contents expectation
aryanputta 7e7c512
Merge branch 'main' into test/api-docs-consistency-2326
mdboom File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,34 @@ | ||
| # SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| from ._buffer import * | ||
| from ._buffer import __all__ as _buffer_all | ||
| from ._device_memory_resource import * | ||
| from ._device_memory_resource import __all__ as _device_memory_resource_all | ||
| from ._graph_memory_resource import * | ||
| from ._graph_memory_resource import __all__ as _graph_memory_resource_all | ||
| from ._ipc import * | ||
| from ._ipc import __all__ as _ipc_all | ||
| from ._legacy import * | ||
| from ._managed_buffer import ManagedBuffer | ||
| from ._legacy import __all__ as _legacy_all | ||
| from ._managed_buffer import * | ||
| from ._managed_buffer import __all__ as _managed_buffer_all | ||
| from ._managed_memory_resource import * | ||
| from ._managed_memory_resource import __all__ as _managed_memory_resource_all | ||
| from ._pinned_memory_resource import * | ||
| from ._pinned_memory_resource import __all__ as _pinned_memory_resource_all | ||
| from ._virtual_memory_resource import * | ||
| from ._virtual_memory_resource import __all__ as _virtual_memory_resource_all | ||
|
|
||
| __all__ = ( | ||
| _buffer_all | ||
| + _device_memory_resource_all | ||
| + _graph_memory_resource_all | ||
| + _ipc_all | ||
| + _legacy_all | ||
| + _managed_buffer_all | ||
| + _managed_memory_resource_all | ||
| + _pinned_memory_resource_all | ||
| + _virtual_memory_resource_all | ||
| ) |
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
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
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
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
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
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
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: use
__all__ = [ *a, *b, ... ]rather than repeated addition on lists.nit:
__all__is usually a list.Suggested:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry question - what does nit mean? Do you guys want me to work on this or would you guys rather work and finish this off internally, so commits don't get messy? @mdboom @Andy-Jost
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"nit" means small and nice-to-fix but not important enough to block the merge. Sometimes it can also be used to express a small preference that's not worth arguing over if there's any disagreement.
In this case, since CI hasn't been run it's probably worth fixing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay thank you, should I fix this or let micheal finish this off and have him just resolve this issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like Mike already addressed this