How to exclude functions matching a pattern from D100 error?

I have a few functions on a legacy code base named call that do not have a docstring. I would like to be able to specify that I do not want to check for docstring presence for the functions named call. It would be helpful to have an extra configuration with the whitelist of such functions. Adding # noqa comment is not an option.

Is it something already supported? If not, I would love to see this feature implemented. Is it something that I could implement relatively easy in the source code for submitting a PR?

[Nurdok]

@AlexArcPy that’s great. Sorry for the push back, but as with any open source project, each user has their own unique use case and we need to make sure features are applicable to a large portion of them to avoid feature creep and to keep the code maintainable.

Cheers!

[Nurdok]

For magic methods there’s a separate error code specifically designed for this common use case. But the main reason we handle that case is that the APIs for these methods is known from their name.

In your example, say, read_cli_args, I think there’s still reason to document the function: does it return a value? In what format? What’s the behavior for invalid CLI flags? etc., etc.

If your general opinion is “some constructs do not need docstrings because their name is self-explanatory”, you can simply turn off all of the D1xx “missing docstring” error codes.