overlong-py-comment-blocks-check

This is a pre-commit hook, written for the pre-commit.com framework, which looks for python modules containing suspiciously long comment blocks (i.e. blocks of code all of whose lines begin with the "#" character, ignoring leading whitespace).

The motivation is to help with looking for dead/old/commented out code in a large codebase.

Configuration

Example .pre-commit-config.yaml entry:

• repo: https://github.com/gimbo/overlong-py-comment-blocks-check.git

• id: overlong-py-comment-blocks-check

The threshold argument controls how long a block must be (in lines) in order to be considered a problem; the default is 20.

Future work

• Possibly: a way to mark a given block so that it's ignored by this