Documentation Follow Up #957
Merged
Conversation
This file contains hidden or 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
|
Reviewing... |
hakonanes
requested changes
Nov 2, 2023
|
|
||
| Parameters | ||
| ---------- | ||
| roi: :obj:`hyperspy.roi.BaseInteractiveROI` | ||
| roi: :obj:`~hyperspy.roi.BaseInteractiveROI` |
There was a problem hiding this comment.
I don't think we need the reST Sphinx syntax here?
Suggested change
| roi: :obj:`~hyperspy.roi.BaseInteractiveROI` | |
| roi : hyperspy.roi.BaseInteractiveROI |
There was a problem hiding this comment.
I kind of like the explicit references. I think if the class isn't imported it seems like the Sphinx mapping doesn't work At least I think that is the case. Maybe if we add in type checking we could simplify things but I'd rather have things consistent for now.
| ---------- | ||
| s: Signal2D | ||
| s: :class:`~hyperspy.api.signals.Signal2D` |
There was a problem hiding this comment.
Suggested change
| s: :class:`~hyperspy.api.signals.Signal2D` | |
| s : hyperspy.api.signals.Signal2D |
| function. Default is 10 | ||
| **kwargs: | ||
| Passed to the :meth:`get_time_series` function | ||
| kwargs: |
There was a problem hiding this comment.
I find **kwargs renders better in the docs than just kwargs. You can drop the colon here.
Open
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.
name: Documentation Follow Up
about: Cleaning up warnings in documentation Build
Checklist