fix(collector): fix documentation for ResourceMetricCollector.clear()
function
#132
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.
The docstrings of
ResourceMetricCollector
referred to theclear()
function asreset()
, which is not existing.Therefore, I replaced each mention of
reset()
withclear()
in the documentation.Issue Type
Runtime Environment
3.7.2
/3.9.6
]460.84
]nvitop
version or commit: [e.g.0.10.0
/0.10.1.dev7+ga083321
/main@75ae3c
]python-ml-py
version: [e.g.11.450.51
]C
/C.UTF-8
/en_US.UTF-8
]Description
Within the
ResourceMetricCollector
class, theclear()
function was not used in the documentation for the class, nor the docstring of the function itself, butreset()
.As the
reset()
function is not existing forResourceMetricCollector
, I replaced all occurrences of it in the documentation withclear()
as well as changing the description of theclear()
function to reflect it's name better.Motivation and Context
The motivation is, that I was looking at the documentation and tried to use the
reset()
function for aResourceMetricCollector
instance, and encountered an error.I had to look at the code to see that the function I have to use is called
clear()
.Testing
As I only changed the docstrings within the
ResourceMetricCollector
class, I did not test my changes.