interrogate icon indicating copy to clipboard operation
interrogate copied to clipboard

Option to ignore overloaded functions

Open ErwinJunge opened this issue 4 years ago • 2 comments

Describe the feature you'd like

When decorating functions with @typing.overload, the stubs are marked as not covered when they don't have their own docstring. My suggestion is to add an option to ignore those stubs.

Is your feature request related to a problem?

We have overloaded functions in our codebase that we want to start using this package in and we only document the actual implementation and not the stubs.

Your Environment

  • interrogate version(s) (interrogate --version: 1.5.0
  • Operating System(s): linux
  • Python version(s): 3.6-3.10

Additional context

PR incoming.

ErwinJunge avatar Dec 17 '21 16:12 ErwinJunge

Another option is to ignore flake8 rule D418 (doesn't allow docstrings for overloads) and just give the overloaded functions/methods docstrings. But agree it would be good to have the option to have interrogate ignore them for this purpose.

amin-nejad avatar Jul 18 '22 09:07 amin-nejad

Had to disable interrogate since I started making use of overloads.

jmahlik avatar May 18 '23 17:05 jmahlik