Story #1718
closed
As a pulp developer, I see meaningful docstrings on all modules and functions/methods
0%
Description
Our docs currently require that docstring be added to all new functions/methods, so this primarily applies retroactively to existing code that does not yet help tell this story.
The pulp_openstack plugin attempts this using the pep257 package, but adds exceptions for every warning/error and is thus rendered effectively useless. Nevertheless, it (or something like it) can be used to find errors in our docstrings, with the most common error apparently being a lack of them.
pep257 may be deprecated in favor of pydocstyle, but it's not clear to me which is "better".
https://pep257.readthedocs.org/en/latest/ vs. https://pydocstyle.readthedocs.org/en/latest/
This should probably also apply to all plugins, and may qualify as an epic story.
.