serhii.net

In the middle of the desert you can say anything you want

13 Sep 2024

flake8 and docstrings

TL;DR:


pydocstyle / python-flake8-docstrings is a thing. Forgot I had it installed and spent a lot of time trying to understand pycharm’s output

Usage — pydocstyle 0.0.0.dev0 documentation flake8-docstrings · PyPI

To ignore things, you don’t do:

[pydocstyle]
convention = google
ignore = D401

It’s either ignore or convention. Which quietly happened in the background, and I thought it doesn’t read my config file since D401 was still shown.

Correct would be this:

[pydocstyle]
convention = google
add-ignore = D401

EDIT GodDAMN it, pydocsyle parsing a config file doesn’t mean that flake8(-..docstring) will.

Reading the flake8 plugin docs, I should add THIS and to flake8 config file. Ignores also are set up there using the usual way.

docstring-convention=google

And the pydoctest config file search and add-ignore is irrelevant. God lost so much time to this

Nel mezzo del deserto posso dire tutto quello che voglio.
comments powered by Disqus