-
Notifications
You must be signed in to change notification settings - Fork 76
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
DOC: Enable nitpicky in doc build #813
Conversation
This comment has been minimized.
This comment has been minimized.
docs/imviz/notebook.rst
Outdated
`Astrowidgets <https://astrowidgets.readthedocs.io/en/latest/>`_ API. | ||
For example:: | ||
|
||
viewer = imviz.get_viewer('viewer-1') |
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.
This will be true after #854 is merged.
@@ -67,6 +67,5 @@ A slit can be added to the image viewer by opening the Slit Overlay plugin and c | |||
The :guilabel:`Remove` button can be used to remove a slit once it has been applied to the image viewer. | |||
|
|||
In order to plot a slit onto the image viewer, we need WCS information from an image and slit position from a 2D spectrum. | |||
WCS information is taken from the `meta` attribute of the :class:`~astropy.nddata.CCDData` object representing the data in the |
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.
This is no longer true after #850 is merged, so I removed it here.
@@ -0,0 +1,5 @@ | |||
# https://github.com/mariobuikhuizen/ipyvuetify/issues/180 |
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.
# https://github.com/mariobuikhuizen/ipyvuetify/issues/180 | ||
py:class ipyvuetify.VuetifyTemplate.VuetifyTemplate | ||
|
||
# https://github.com/glue-viz/glue-jupyter/issues/258 |
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.
Codecov Report
@@ Coverage Diff @@
## main #813 +/- ##
=======================================
Coverage 68.29% 68.29%
=======================================
Files 65 65
Lines 4741 4741
=======================================
Hits 3238 3238
Misses 1503 1503
Continue to review full report at Codecov.
|
@@ -40,16 +40,16 @@ Here, users can select the loaded data set to be visualized in the viewer. | |||
Loading data via the API | |||
------------------------ | |||
Alternatively, if users are working in a coding environment like a Jupyter notebook, they have access to the :class:`~jdaviz.configs.specviz.helper.Specviz` helper class API. Using this API, users can load data into the application through code. | |||
Below is an example of importing the :class:`~jdaviz.configs.specviz.helper.Specviz` helper class, creating a :class:`~specutils.Spectrum1D` object from a data file via the :func:`~specutils.Spectrum1D.read` method:: | |||
Below is an example of importing the :class:`~jdaviz.configs.specviz.helper.Specviz` helper class, creating a :class:`~specutils.Spectrum1D` object from a data file via the `specutils.Spectrum1D.read` method:: |
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.
@rosteen pointed out that specutils.Spectrum1D.read
is listed as "attribute" upstream even though it is a method. 🤷 xref astropy/specutils#867
`glue.core.Hub` | ||
The internal ``Hub`` instance for the application. | ||
Reference to the stored application handler `~glue.core.hub.Hub` instance | ||
for the application. |
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.
Note: @property
does not really need a "Returns" section. They must return something by definition.
Data object with the spectrum. | ||
color: color specification |
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.
Unless someone can tell me exactly what Python data types "color specification" refers to, we should just leave it blank as an ambiguous "obj" type.
and error in rebase.
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.
LGTM!
Description
This pull request is fix #812
Checklist for package maintainer(s)
This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.
trivial
label.CHANGES.rst
?