-
Notifications
You must be signed in to change notification settings - Fork 28
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
Docstring improvement and check API links #142
Conversation
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #142 +/- ##
==========================================
- Coverage 85.65% 85.59% -0.07%
==========================================
Files 74 74
Lines 9795 9800 +5
Branches 2085 2163 +78
==========================================
- Hits 8390 8388 -2
- Misses 907 913 +6
- Partials 498 499 +1
☔ View full report in Codecov by Sentry. |
9037513
to
f5c43d8
Compare
3037a6d
to
74156d5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for all the cleanup!
CONTRIBUTING.rst
Outdated
@@ -148,6 +148,11 @@ be used (see existing plugins). | |||
|
|||
The *docstrings* are automatically added in the *user guide* using the following lines |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code block should remain after this paragraph (this paragraph can also come after the new one).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Opss! This is now fixed - along with some typo and formatting issues.
…il they are fixed in `hyperspy`
2218f11
to
fcef136
Compare
Progress of the PR
sphinx-favicon
sincefavicons
option ofpydata-sphinx-theme
is deprecatednitpicky
option to check link to API,upcoming_changes
folder (seeupcoming_changes/README.rst
),readthedocs
doc build of this PR (link in github checks)