Skip to content
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

Merged
merged 3 commits into from
Sep 15, 2021
Merged

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Aug 26, 2021

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.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a change log needed? If yes, is it added to CHANGES.rst?
  • Is a milestone set? Milestone is only currently required for PRs related to Imviz MVP.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@github-actions github-actions bot added the documentation Explanation of code and concepts label Aug 26, 2021
@pllim

This comment has been minimized.

`Astrowidgets <https://astrowidgets.readthedocs.io/en/latest/>`_ API.
For example::

viewer = imviz.get_viewer('viewer-1')
Copy link
Contributor Author

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@codecov
Copy link

codecov bot commented Sep 14, 2021

Codecov Report

Merging #813 (6c09a12) into main (36605e8) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #813   +/-   ##
=======================================
  Coverage   68.29%   68.29%           
=======================================
  Files          65       65           
  Lines        4741     4741           
=======================================
  Hits         3238     3238           
  Misses       1503     1503           
Impacted Files Coverage Δ
jdaviz/app.py 82.66% <ø> (ø)
...specviz/plugins/unit_conversion/unit_conversion.py 73.64% <ø> (ø)
jdaviz/configs/specviz/plugins/viewers.py 60.75% <ø> (ø)
jdaviz/core/template_mixin.py 100.00% <ø> (ø)
jdaviz/core/helpers.py 18.00% <100.00%> (ø)
jdaviz/core/registries.py 79.03% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 36605e8...6c09a12. Read the comment docs.

@@ -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::
Copy link
Contributor Author

@pllim pllim Sep 14, 2021

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.
Copy link
Contributor Author

@pllim pllim Sep 14, 2021

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
Copy link
Contributor Author

@pllim pllim Sep 14, 2021

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.

@pllim pllim marked this pull request as ready for review September 14, 2021 17:30
@pllim pllim requested a review from kecnry September 14, 2021 17:30
@pllim pllim added this to the Imviz 1.0 milestone Sep 14, 2021
and error in rebase.
Copy link
Collaborator

@rosteen rosteen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@rosteen rosteen merged commit 5d8a896 into spacetelescope:main Sep 15, 2021
@pllim pllim deleted the doc-nitpicky branch September 15, 2021 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Explanation of code and concepts Ready for final review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable nitpicky mode in docs building
2 participants