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: Fix Imviz Contrast/Bias doc and other minor updates #1385

Merged
merged 1 commit into from
Jun 10, 2022

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Jun 9, 2022

Description

This pull request is to update some really outdated docs, particularly for Imviz, but not attempting to fix everything.

Rendered doc: https://jdaviz--1385.org.readthedocs.build/en/1385/imviz/displayimages.html#contrast-bias

Fixes #1360

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?
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

and other minor updates
@pllim pllim added bug Something isn't working trivial Only needs one approval instead of two no-changelog-entry-needed changelog bot directive labels Jun 9, 2022
@pllim pllim added this to the 2.7 milestone Jun 9, 2022
@github-actions github-actions bot added the documentation Explanation of code and concepts label Jun 9, 2022
@pllim
Copy link
Contributor Author

pllim commented Jun 9, 2022

Not sure why the dev job tanked but this PR does not touch any code, so it is unrelated.

@codecov
Copy link

codecov bot commented Jun 9, 2022

Codecov Report

Merging #1385 (4d94d64) into main (8c3d3e7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1385   +/-   ##
=======================================
  Coverage   84.91%   84.91%           
=======================================
  Files          91       91           
  Lines        8288     8288           
=======================================
  Hits         7038     7038           
  Misses       1250     1250           

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 8c3d3e7...4d94d64. Read the comment docs.

Copy link
Member

@kecnry kecnry left a comment

Choose a reason for hiding this comment

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

Let's get this in, definitely an improvement over the outdated icons/text. Thanks!

@kecnry kecnry merged commit fbb644d into spacetelescope:main Jun 10, 2022
@pllim pllim deleted the contrast-bias-doc branch June 10, 2022 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working 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.

Imviz doc on contrast bias button is outdated
2 participants