Open biosafetylvl5 opened 3 months ago
Child of #531
@biosafetylvl5, @evrose54 has made a lot of updates to the docstrings for the CLI in the process of doing other PRs. Would you please assess the current docstrings to determine whether any require further updating?
This is in reference to my review of #444, see #444 for all instances - I commented on each.
Here is an example of a docstring not meeting numpy standards:
This breaks the numpy doc string standard.
The first line should be a "one-line summary that does not use variable names or the function name"
The section after should be dedicate to "extended description. This section should be used to clarify functionality, not to discuss implementation detail or background theory, which should rather be explored in the Notes section below. You may refer to the parameters and the function name, but parameter descriptions still belong in the Parameters section."
Here is an example of an inaccurate docstring:
and another:
Numpy standards: https://numpydoc.readthedocs.io/en/latest/format.html#short-summary