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

pydocstyle is no longer maintened and has isssues with overload #185

Closed
fzimmermann89 opened this issue Feb 25, 2024 · 2 comments
Closed

Comments

@fzimmermann89
Copy link
Member

We are currently using pydocstyle in our precommit.
This is deprecated PyCQA/pydocstyle#658 and, more importantly, has a number of issues with
@overload. PyCQA/pydocstyle#613, PyCQA/pydocstyle#525, PyCQA/pydocstyle#635

For example, I fail to make something like this pass our precommit

@overload __add__(self,other:float)-> float: ...

@overload __add__(self,other:int)-> int: ...

def __add__(self,other:int|float)->int|float
''' Add an int or float. '''

which I would like to use..

@fzimmermann89
Copy link
Member Author

Also, I would vote to ignore D105
Docstrings on magic methods in magic methods are not that useful in most cases

@schuenke
Copy link
Collaborator

Is this solved by #193 ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants