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
I vote for docstrings in tmpo-py. Now, some functions are unclear to me. We can write the docstrings while working on the unittest, both go hand-in-hand.
For docstrings, the following format is normally rendered well by most tools
def myfunc(self, arg1, arg2=200):
"""
One line to describe what the function does
Parameters
---------------
* arg1 : Type of arg1
Description of arg1
* arg2 : Integer (default=200)
Description of arg2
Returns
----------
res : type and description
Raises
----------
this is optional: a description of exceptions that can be raised
Notes
----------
A longer description of the function, with notes for using, implementation, details, etc.
"""
The text was updated successfully, but these errors were encountered:
I vote for docstrings in tmpo-py. Now, some functions are unclear to me. We can write the docstrings while working on the unittest, both go hand-in-hand.
For docstrings, the following format is normally rendered well by most tools
The text was updated successfully, but these errors were encountered: