How to write a proper docstring?
Answer
•Briefly: what the function does.
•Describe arguments and return value.
•Mention exceptions if important.
•Usage examples help.
•Follow a style (Google/Numpy) consistently in the project.
Was this answer helpful?