Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!
Tips and Traps¶
It is suggested that you avoid using
darglintdirectly, but instead you can useflake8which will automatically calldarglintif it exists.Improperly escaped
\ncausesdarglintfail to parse the docstring.
Configuration¶
It is suggested that you place configuration into a file named .darglint
under the root directory of your project.
When darglint supports pyproject.toml,
the configuration should be moved into pyproject.toml.
Below is an example of configuration.
:::text
[darglint]
docstring_style=sphinx
message_template={path}:{line}: {msg_id}: {msg}