Pracuję nad projektem, który wymaga dokumentacji Numpy. W moich dniach Java pamiętam o lintersach, które sprawdzały zgodność Javadoc w Eclipse/IDEA; czy istnieje odpowiednik, który sprawdza przestrzeganie stylu dokumentacji Numpy?Czy istnieje sposób na lint pliku Python, aby sprawdzić przestrzeganie stylu dokumentacji Numpy?
Wiem o PEP257, ale nie ma żadnych konkretnych kontroli dokumentacji Numpy.
Pylint wydaje się to wspierać. Spójrz na pylint.extensions.docparams.
Podsumowując. Po włączeniu tej sprawdzania z pylint dodając
load-plugins=pylint.extensions.docparams
w sekcji panem swojego .pylintrc.
Ten kontroler sprawdza, czy wszystkie funkcje, metody i konstruktorów docstrings zawierać dokumentację
parametrów i ich rodzaje
wartości zwracanej i jego typ
wyjątków podniesiony
Właściwie pydocstyle (dawniej pep257) recently added support dla numpy konwencji docstring. Chociaż nie jest idealny Myślę, że jest najbliżej tego, co chcesz osiągnąć i prawdopodobnie poprawi się w najbliższej przyszłości.
pydocstyle --convention=numpy example.py
że kontroler może obsługiwać numpy (m.in. takich jak Sphinx) Styl i sprawdzić te rzeczy, ale nie sądzę, że ma sposób odróżniając go od tych innych stylów. Na przykład, jeśli napiszesz kod z dokumentacją Sphinx, to linter powiedziałby, że to było w porządku, nawet jeśli chcesz tylko odręcznego stylu - nie widzę sposobu na określenie ekskluzywnego stylu dokumentacji – Andrew
@Andrew, hmmm przykro mi, wydaje mi się, że przeoczyłem aby wziąć pod uwagę tę część przestrzegania, zaktualizowałem swoją odpowiedź. –