Exceptions on script docstrings

terrencepreilly / darglint

A python documentation linter which checks that the docstring description matches the definition.

MIT License

483 stars 41 forks source link

Exceptions on script docstrings #139

Closed RoyalTS closed 3 years ago

RoyalTS commented 4 years ago

I'm getting exceptions a la

"""Functions to process the raw data."""
^
src/home_credit_default_risk/utils/misc/formatting.py:1:1: DAR000: Unexpected exception in darglint: Unsupported section type, Sections.VARIABLES_SECTION

when running the latest darglint release as a pre-commit hook using numpy style. The docstring being highlighted is not the docstring of a function but one at the top of a python script as per D100/D104.

terrencepreilly commented 3 years ago

Closing as a duplicate of Issue #133