-
Notifications
You must be signed in to change notification settings - Fork 84
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
Documentation Follow Up #957
Conversation
Reviewing... |
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.
Thank you for this follow-up. I have a few comments regarding reST syntax!
|
||
Parameters | ||
---------- | ||
roi: :obj:`hyperspy.roi.BaseInteractiveROI` | ||
roi: :obj:`~hyperspy.roi.BaseInteractiveROI` |
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.
I don't think we need the reST Sphinx syntax here?
roi: :obj:`~hyperspy.roi.BaseInteractiveROI` | |
roi : hyperspy.roi.BaseInteractiveROI |
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.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find **kwargs renders better in the docs than just kwargs. You can drop the colon here.
name: Documentation Follow Up
about: Cleaning up warnings in documentation Build
Checklist