Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

DOCS: Update cubeviz slice docs #1158

Merged
merged 2 commits into from
Mar 11, 2022
Merged

Conversation

javerbukh
Copy link
Contributor

@javerbukh javerbukh commented Mar 10, 2022

Description

This pull request is to address the changed UI since these docs were made and add some more context on toolbar interactions with the slice tool.

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)?

@javerbukh javerbukh added documentation Explanation of code and concepts no-changelog-entry-needed changelog bot directive labels Mar 10, 2022
@codecov
Copy link

codecov bot commented Mar 10, 2022

Codecov Report

Merging #1158 (be36be7) into main (b1f1748) will decrease coverage by 0.75%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1158      +/-   ##
==========================================
- Coverage   76.86%   76.10%   -0.76%     
==========================================
  Files          87       87              
  Lines        6661     6667       +6     
==========================================
- Hits         5120     5074      -46     
- Misses       1541     1593      +52     
Impacted Files Coverage Δ
jdaviz/configs/imviz/wcs_utils.py 66.66% <0.00%> (-26.67%) ⬇️
jdaviz/configs/imviz/plugins/compass/compass.py 85.00% <0.00%> (-12.50%) ⬇️
jdaviz/configs/imviz/plugins/viewers.py 74.12% <0.00%> (-9.10%) ⬇️
...configs/default/plugins/data_tools/file_chooser.py 65.71% <0.00%> (-3.43%) ⬇️
...igs/specviz/plugins/line_analysis/line_analysis.py 84.76% <0.00%> (-0.49%) ⬇️
jdaviz/core/template_mixin.py 100.00% <0.00%> (ø)
jdaviz/core/registries.py 79.68% <0.00%> (+0.65%) ⬆️

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 b1f1748...be36be7. Read the comment docs.

@pllim pllim added this to the 2.4 milestone Mar 10, 2022
@pllim pllim added cubeviz trivial Only needs one approval instead of two labels Mar 10, 2022
@@ -41,6 +41,13 @@ the wavelength entry will update to the exact value of that slice).

The spectrum viewer also contains a tool to allow clicking and
dragging in the spectrum plot to choose the currently selected slice.
If another toolbar icon is selected, and then deselected after use,
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe it is best if @kecnry can look at this since he implemented this feature.

Copy link
Member

Choose a reason for hiding this comment

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

right now this is technically true, but will change slightly if/when #1115 is merged. Maybe it would be simpler to just skip this part about deselecting, etc, and say "When the slice to is active, clicking anywhere on the spectrum viewer will select the nearest slice across all viewers, even if the indicator is off-screen"? The underlying logic for "defaulting" tools is somewhat complex to explain in words, but I think is intuitive and quickly learned just by using it 🤞

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good, I updated the text in the latest commit. Thanks!

@kecnry kecnry merged commit e9b572a into spacetelescope:main Mar 11, 2022
@javerbukh javerbukh deleted the cube_slice_docs branch March 11, 2022 16:50
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
cubeviz documentation Explanation of code and concepts no-changelog-entry-needed changelog bot directive trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants