Project

Profile

Help

Story #1718

closed

As a pulp developer, I see meaningful docstrings on all modules and functions/methods

Added by semyers over 8 years ago. Updated about 5 years ago.

Status:
CLOSED - WONTFIX
Priority:
Low
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Pulp 2
Sprint:
Quarter:

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.

Also available in: Atom PDF