Darglint2

A functional docstring linter which checks whether a docstring’s description matches the actual function/method implementation. Darglint2 expects docstrings to be formatted using the Google Python Style Guide, or Sphinx Style Guide, or Numpy Style Guide.

Feel free to submit an issue/pull request if you spot a problem or would like a feature in darglint2.

• Project Status
• Recommended alternatives
• Installation
• Configuration
  • Error Configuration
  • Message Template Configuration
  • Strictness Configuration
  • Ignoring common exceptions
  • Logging
• Usage
  • Command Line use
  • Ignoring Errors in a Docstring
  • Type Annotations
  • Error Codes
• Scope
• Sphinx
• Numpy
• Integrations
  • Flake8
  • SublimeLinter
  • Pre-commit
• Roadmap
• Development and Contributions
  • Development Setup
  • Tooling and tests
  • Contribution

Development

• Change Log
• License

Links

• Github
• PyPI