Run the docstrings linter 'pep257' against the Treeherder repo

NEW
Unassigned

Status

Tree Management
Treeherder: Docs & Development
P3
normal
2 years ago
13 days ago

People

(Reporter: emorley, Unassigned)

Tracking

Details

(Reporter)

Description

2 years ago
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/
(Reporter)

Updated

2 years ago
Priority: -- → P4
(Reporter)

Updated

28 days ago
Priority: P4 → P3
(Reporter)

Updated

13 days ago
See Also: → bug 1177559
You need to log in before you can comment on or make changes to this bug.