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

add docstring validation to CI #14

Open
tlpss opened this issue Jan 18, 2023 · 1 comment
Open

add docstring validation to CI #14

tlpss opened this issue Jan 18, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@tlpss
Copy link
Contributor

tlpss commented Jan 18, 2023

ideally would check that docstring

  • is available
  • adheres to google docstring format
  • matches the function arguments and defines all of them (so that after refactoring you get a complaint that the docstring is no longer okay)

https://github.com/PyCQA/pydocstyle does (some of) this

@tlpss
Copy link
Contributor Author

tlpss commented Jan 24, 2023

https://pypi.org/project/darglint/ is another option

@tlpss tlpss self-assigned this Mar 12, 2023
@Victorlouisdg Victorlouisdg added the enhancement New feature or request label Aug 31, 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
Projects
None yet
Development

No branches or pull requests

2 participants