Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding skip-option for singledispatch and overloaded functions. #125

Open
vacarme opened this issue Dec 15, 2022 · 3 comments
Open

Adding skip-option for singledispatch and overloaded functions. #125

vacarme opened this issue Dec 15, 2022 · 3 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@vacarme
Copy link

vacarme commented Dec 15, 2022

Hello.
May what do you guys think of adding some skip options which seems to me relevant and not driven by docstring-fatigue.

  • @functools.singledispatch
  • @overloaded

Both tends to make code longer to read, sometimes docstring usage could be relevant for each signatures but in some cases a docstring below the first signature is enough, because the behavior Is self-explanatory.

@functools.singledispatch could be to ignore function named _.

@MiWeiss
Copy link
Collaborator

MiWeiss commented Dec 20, 2022

Hi @vacarme

Sounds reasonable, but I'm afraid that adding too many special ignore flags will eventually make docstr-coverage too verbose.

Maybe we could thinkg about some multi-value argument, e.g, --ignore-annotation @some @annotation @and @more but I'd have to think about how to eventually do this (e.g. how to treat different imports, e.g. @functools.singledispatch vs. from functools import singledispatch followed by @singledispatch.

@HunterMcGushion What do you think?

@MiWeiss MiWeiss added the enhancement New feature or request label Dec 20, 2022
@HunterMcGushion
Copy link
Owner

I agree with @MiWeiss. This does sound like a useful option, but I'm concerned about adding too many flags. @vacarme, would simply --excludeing _ be sufficient in this case?

@MiWeiss
Copy link
Collaborator

MiWeiss commented Jan 3, 2023

I'm opening this up for anyone to come up with a smart proposal on how something along the lines of --ignore-annotation @some @annotation @and @more could be achieved.

@MiWeiss MiWeiss added the help wanted Extra attention is needed label Jan 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants