Find some way to check if function docstrings follow a certain standard, with respect to parameters and such. The conclusion of this should be documented at WMSE wiki.
Description
Description
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Declined | Sebastian_Berlin-WMSE | T156903 Find way to check docstrings | |||
| Resolved | Lokal_Profil | T154471 Standardize workflow for code quality |
Event Timeline
Comment Actions
There are documentation generators that support different types of documentation syntaxes, but I haven't found one that enforces these, i.e. fails if they're not followed. See: https://wiki.python.org/moin/DocumentationTools.
Comment Actions
After a lot of searching, I couldn't find any tool that does this. It may be possible to use one of the document generators and check the output somehow.