Project

Profile

Help

Story #1718

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

Added by semyers almost 6 years ago. Updated almost 3 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.

History

#1 Updated by bmbouter almost 3 years ago

  • Status changed from NEW to CLOSED - WONTFIX

#2 Updated by bmbouter almost 3 years ago

Pulp 2 is approaching maintenance mode, and this Pulp 2 ticket is not being actively worked on. As such, it is being closed as WONTFIX. Pulp 2 is still accepting contributions though, so if you want to contribute a fix for this ticket, please reopen or comment on it. If you don't have permissions to reopen this ticket, or you want to discuss an issue, please reach out via the developer mailing list.

#3 Updated by bmbouter almost 3 years ago

  • Tags Pulp 2 added

Also available in: Atom PDF