Open
Conversation
|
Remove helper/data-container classes from cuda.core.system's public API (__all__) since they are not intended to be directly instantiated by users. These classes are returned by Device properties/methods and serve as nested data containers. Classes removed from __all__: BAR1MemoryInfo, ClockInfo, ClockOffsets, CoolerInfo, DeviceAttributes, DeviceEvents, EventData, FanInfo, FieldValue, FieldValues, GpuDynamicPstatesInfo, GpuDynamicPstatesUtilization, InforomInfo, PciInfo, RepairStatus, Temperature, ThermalSensor, ThermalSettings. Enums, exceptions, Device itself, and free functions remain public. Also: - Update api.rst to document helper classes via their private module path (system._device.ClassName) - Update Device property/method docstrings to link to helper classes using :obj:`~ClassName` role - Update tests to import helper classes from _device module
mdboom
force-pushed
the
privatize-system-helper-classes
branch
from
3bea34c to
f3ab66a
Compare
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.
Also fixes #1941.
Remove helper/data-container classes from
cuda.core.system's public API (__all__) since they are not intended to be directly instantiated by users. These classes are returned byDeviceproperties/methods and serve as nested data containers.Classes removed from
__all__:BAR1MemoryInfo,ClockInfo,ClockOffsets,CoolerInfo,DeviceAttributes,DeviceEvents,EventData,FanInfo,FieldValue,FieldValues,GpuDynamicPstatesInfo,GpuDynamicPstatesUtilization,InforomInfo,PciInfo,RepairStatus,Temperature,ThermalSensor,ThermalSettings.Enums, exceptions,
Deviceitself, and free functions remain public.Changes
__all__in_device.pyxapi.rstto document helper classes via their private module path (system._device.ClassName)Deviceproperty/method docstrings to link to helper classes using:obj:role_devicemodule