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

Enforcement of doc strings? #28

Open
rohanpm opened this issue Sep 15, 2019 · 1 comment
Open

Enforcement of doc strings? #28

rohanpm opened this issue Sep 15, 2019 · 1 comment

Comments

@rohanpm
Copy link
Owner

rohanpm commented Sep 15, 2019

Here's an idea: if pidiff detects that an API was added in version x.y.0, could it perhaps also check __doc__ and complain if no matching .. versionadded:: x.y.0 was found?

This would have to be an optional check.

@rohanpm
Copy link
Owner Author

rohanpm commented Jul 1, 2020

Even better would be if the string could be added automatically (or setting things up so that another tool would be able to do that).

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

1 participant