Replies: 2 comments 1 reply
-
|
Doing my first test, looks which it offers benefits visually in the code using the Python doc strings. Furthermore, on the official documentation website. In this example, I took the class I resolved the issue Original code: Fixed Screenshots: Original Fixed |
Beta Was this translation helpful? Give feedback.
-
|
This is great! Does the linter automatically apply fixes, or is it manual? |
Beta Was this translation helpful? Give feedback.
-
|
It is manual. There are some improvements trying to fix automatically the doc-strings, but they are limited. In this Stack Overflow answer about “How to make pylint, flake8 or pycodestyle to automatically correct errors?”; it mentioned some Python package called “autopep8”, which only improve two topics for doc-strings:
Furthermore, some warnings are about structure rather than style. Implementing these packages helps for some syntaxes, and it is valuable, but at the end it needs human review. |
Beta Was this translation helpful? Give feedback.
-
Could we add a validator for RST (reStructuredText)?
I installed the flake8-rst-docstrings. It validates very fast (~2s) the doc strings for all the files in
tardis/which located 224 issues.Maybe a suitable approach is checking a couple of issues marked here; then resolve the issue and check the differences in the documentation.
time flake8 --select RST tardis/Beta Was this translation helpful? Give feedback.
All reactions