You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The __init__.py override dynamically passes all args and kwargs so that can (and should) inherit whatever docstring the parent has (no further action required on your part)
The update override does introduce an additional argument (always_callback), so something to think on here...
is this argument actually required? What is its effect? Is there any alternative way to handle this?
otherwise, will have to think on best way to handle this. The inherited docstring won't include the detail of this new parameter, and a manually defined docstring won't necessarily match up with a particular version of tqdm... This might be a case where dynamic docstring injection is actually appropriate
The other two new methods are missing docstrings and should really receive some that quickly and concisely describe how the methods should be called - tqdm appears to use NumPy docstring format, so be sure to follow that pattern
The text was updated successfully, but these errors were encountered:
Looks like always_callback isn't really necessary. I'd found it on tqdm/tqdm#845 (comment) where it looked like it was used—though I don't believe that this argument is ever actually passed.
Two methods of the class here are overrides
The
__init__.py
override dynamically passes allargs
andkwargs
so that can (and should) inherit whatever docstring the parent has (no further action required on your part)The
update
override does introduce an additional argument (always_callback
), so something to think on here...tqdm
... This might be a case where dynamic docstring injection is actually appropriateThe other two new methods are missing docstrings and should really receive some that quickly and concisely describe how the methods should be called -
tqdm
appears to use NumPy docstring format, so be sure to follow that patternThe text was updated successfully, but these errors were encountered: