Skip to content

[doc-only] Fix stale NVML API catalog entries - #3386

Open
mdboom wants to merge 1 commit into
NVIDIA:mainfrom
mdboom:issue3382
Open

mdboom wants to merge 1 commit into
NVIDIA:mainfrom
mdboom:issue3382

Conversation

@mdboom

@mdboom mdboom commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

Fixes #3382

Three names in the NVML types catalog (nvml.rst) could not be imported, so Sphinx warned and omitted them:

  • Remove EventData_v2 (EventData is already documented).
  • Replace GpuOperationalEventContextLegacyXid_v1 with EventSetGetGpuOperationalEventContextLegacyXid_v1.
  • Replace OperationalEventContextInfo_v1 with EventSetGetContextInfo_v1.

The replacements are placed alphabetically after EventData. The docs have not been rebuilt locally.

🤖 Generated with Claude Code

Remove EventData_v2 and replace GpuOperationalEventContextLegacyXid_v1 and
OperationalEventContextInfo_v1 with the exported
EventSetGetGpuOperationalEventContextLegacyXid_v1 and
EventSetGetContextInfo_v1.

Fixes NVIDIA#3382

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added the cuda.bindings Everything related to the cuda.bindings module label Nov 5, 2026
@mdboom mdboom self-assigned this Nov 5, 2026
@mdboom mdboom added this to the cuda.bindings next milestone Nov 5, 2026
@coderabbitai

coderabbitai Bot commented Nov 5, 2026

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Updated the NVML type reference: it now lists EventSetGetContextInfo_v1 and EventSetGetGpuOperationalEventContextLegacyXid_v1 in place of EventData_v2.
    • Removed GpuOperationalEventContextLegacyXid_v1 and OperationalEventContextInfo_v1 from the reference list.

The NVML type autosummary removes stale entries and adds the corresponding exported type names.

Changes: NVML type catalog

Layer / File(s) Summary
Update NVML type entries
cuda_bindings_13/docs/source/module/nvml.rst
The autosummary replaces EventData_v2 and two stale type entries with EventSetGetContextInfo_v1 and EventSetGetGpuOperationalEventContextLegacyXid_v1.

Assessment against linked issues

Objective Addressed Explanation
Correct the three stale NVML autosummary names and list the two exported replacement types [#3382] ✅

Possibly related issues

Suggested reviewers: rwgk

Change: Bug fix · Severity of issue fixed: Low

Merge Risk: Minimal · up to 3e774

No merge-blocking issue is established in this documentation-only change; run the documentation build as a normal validation step.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 3429cba and 3e774ce.

Files selected for processing: 1

  • cuda_bindings_13/docs/source/module/nvml.rst

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 9 remain after this review.

@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

@mdboom mdboom added the documentation Improvements or additions to documentation label Nov 5, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cuda.bindings Everything related to the cuda.bindings module documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC]: NVML API catalog references three names that are not exported

1 participant