-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
DOC: Use google style docstrings #1534
Conversation
8d1bea4
to
2c1277c
Compare
Codecov ReportBase: 91.83% // Head: 91.83% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #1534 +/- ##
=======================================
Coverage 91.83% 91.83%
=======================================
Files 33 33
Lines 6073 6073
Branches 1193 1193
=======================================
Hits 5577 5577
Misses 321 321
Partials 175 175
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
16a506d
to
b738fe5
Compare
The Google Docstring style is way more readable than ReST style docstrings. Additionally, replace most instances of 'pragma: no-cover' by 'deprecated'. Tools used: - pyment - pydocstyle
b738fe5
to
4d8f506
Compare
New Features (ENH): - Accept hierarchical fields (#1529) Documentation (DOC): - Use google style docstrings (#1534) - Fix linked markdown documents (#1537) Developer Experience (DEV): - Update docs config (#1535) [Full Changelog](3.2.0...3.2.1)
The Google Docstring style is way more readable than ReST style docstrings.
Additionally, replace most instances of 'pragma: no-cover' by 'deprecated'
Tools used: