Lintel’s documentation

Lintel is a static analysis tool for checking compliance with Python docstring conventions.

• Usage
  • Configuration Files
  • Ignore error codes in-file
  • Usage with pre-commit
• Error Codes
  • Conventions
  • Publicity
• License

Credits

Lintel started as a fork of pydocstyle with the goal to eventually also cover the functionality provided by pylint’s docparams extension.

Lintel behaves very similar to pydocstyle in terms of docstring checks but it lacks some of the more advanced configuration options, e.g., configuration inheritance.