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.

Sign up for GitHub

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

Jump to bottom

Enforce pydocstyle in pre-commit hooks #2193

Open
nikosavola opened this issue Oct 17, 2023 · 2 comments
Open

Enforce pydocstyle in pre-commit hooks #2193

nikosavola opened this issue Oct 17, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@nikosavola
Copy link
Member

Is your feature request related to a problem? Please describe.
Some of the function docstrings in gdsfactory have inconsistent formatting. Additionally, in gplugins some functions seem to have old arguments in the docstrings and new ones haven't been added: https://github.com/gdsfactory/gplugins/blob/77e46b248c4ec2650a61fd119084bac848c002db/gplugins/gmsh/uz_xsection_mesh.py#L193-L237.
D417 would catch this problem.

Describe the solution you'd like

  1. Enforce pydocstyle in pre-commit hooks and check if some rules could be relaxed to make this more pleasant for contributors.
  2. Same for gplugins.
  3. At some point, lint all the current docstrings
@nikosavola nikosavola added the enhancement New feature or request label Oct 17, 2023
@joamatab
Copy link
Contributor

we can use ruff for this, which implements the pydocstyle rules

This was referenced Oct 19, 2023
Closed
Closed
@github-actions GitHub Actions
Copy link

This issue is stale because it has been inactive for 60 days. Remove stale label or comment or this will be closed in 7 days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Enable pydocstyle checks in ruff nikosavola/gdsfactory
2 participants
@joamatab @nikosavola