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

Format docstrings #208

Merged
merged 15 commits into from
Sep 19, 2023
Merged

Format docstrings #208

merged 15 commits into from
Sep 19, 2023

Conversation

mscroggs
Copy link
Member

@mscroggs mscroggs commented Sep 18, 2023

Remove pydocstyle test excludes from setup.cfg, and set convention to google. Make all docstrings satisfy these checks.

For files in the finiteelement/ folder, the garbage docstrings have been added to make the checks pass. This is because in another PR (#197) I'm working on removing these files, so it seems like a waste of time to write nicely formatted docstrings in these files.

Close #202. Close #189.

@mscroggs mscroggs marked this pull request as draft September 18, 2023 11:20
@mscroggs mscroggs marked this pull request as ready for review September 18, 2023 17:28
@mscroggs mscroggs merged commit adcc9ab into main Sep 19, 2023
19 checks passed
@mscroggs mscroggs deleted the mscroggs/google-docstrings2 branch September 19, 2023 07:57
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

Successfully merging this pull request may close these issues.

Enable pydocstyle checks Use Google style docstrings
2 participants