Ignore missing docstring in main function of script

[ajhynes7]

Hello,

I have several Python scripts with this format:

"""Description of the script."""


def main():
    # All of the script code.


if __name__ == "__main__":
    main()
    

It seems redundant to explain the script again inside the main function.

pydocstyle raises this error:

path/to/script.py:4 in public function `main`:
        D103: Missing docstring in public function

I don't want to ignore D103 because it's useful for functions in other modules.

I see that you have a --match option for selecting files that match a regular expression. Perhaps a feature could be added to ignore function names that match a regular expression?

Thanks.

[sigmavirus24]

You can also use # noqa on the def main(): line iirc to disable this

[ajhynes7]

Ok thanks, that works as well. Do you think it would be useful though to add a command line option for excluding a function based on a regular expression? Something like --match-function.

If so, I can try contributing the feature.

[sigmavirus24]

I don't but I'm not a maintainer

[sambhav]

Related to/Duplicate of #537

[KaleabTessera]

This feature would be appreciated! Adding # noqa to many files is not ideal.