DOC: Use google style docstrings #1534
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MartinThoma
force-pushed
the
google-docs
branch
2 times, most recently
from
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. |
MartinThoma
force-pushed
the
google-docs
branch
4 times, most recently
from
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
MartinThoma
force-pushed
the
google-docs
branch
from
b738fe5
to
4d8f506
Compare
MartinThoma
added a commit
that referenced
this pull request
Jan 8, 2023
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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Google Docstring style is way more readable than ReST style docstrings.
Additionally, replace most instances of 'pragma: no-cover' by 'deprecated'
Tools used: