Closed Bug 1195203 Opened 9 years ago Closed 6 years ago

Run the docstrings linter 'pep257' against the Treeherder repo

Categories

(Tree Management :: Treeherder, defect, P3)

Product:
Tree Management
Component:
Treeherder
Type:
defect

Tracking

(Not tracked)

Status:
RESOLVED WONTFIX

People

(Reporter: emorley, Unassigned)

References

Details

The pypi package 'pep257' is a linter for docstrings, which checks for conformity to PEP257.

Given that aiui Django REST Swagger can use docstrings to make the API docs clearer - it seems that cleaning the docstrings up will not only make development easier for people unfamiliar with internal treeherder code, but also improve our public docs.

Running pep257 against the repo at the moment results in ~1200 warnings - so we'll have to see how easy it is to fix a bunch of those and/or tweak the rulesets to make it less strict - before deciding whether we should run this on Travis longer term.

https://github.com/GreenSteam/pep257/
Priority: -- → P4
Priority: P4 → P3
See Also: → 1177559
Status: NEW → RESOLVED
Closed: 6 years ago
Resolution: --- → WONTFIX
Component: Treeherder: Docs & Development → TreeHerder
You need to log in before you can comment on or make changes to this bug.