Docstring improvement and check API links #142
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
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. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
ericpre
force-pushed
the
check_API_links
branch
4 times, most recently
from
9037513
to
f5c43d8
Compare
ericpre
force-pushed
the
check_API_links
branch
3 times, most recently
from
3037a6d
to
74156d5
Compare
ericpre
added
documentation
jlaehne
reviewed
Jul 10, 2023
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.
The code block should remain after this paragraph (this paragraph can also come after the new one).
There was a problem hiding this comment.
Opss! This is now fixed - along with some typo and formatting issues.
…il they are fixed in `hyperspy`
ericpre
force-pushed
the
check_API_links
branch
2 times, most recently
from
2218f11
to
fcef136
Compare
jlaehne
approved these changes
Jul 13, 2023
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.
Progress of the PR
sphinx-faviconsincefaviconsoption ofpydata-sphinx-themeis deprecatednitpickyoption to check link to API,upcoming_changesfolder (seeupcoming_changes/README.rst),readthedocsdoc build of this PR (link in github checks)