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

Disclaimer for background region #1589

Merged
merged 2 commits into from
Aug 19, 2022

Conversation

camipacifici
Copy link
Contributor

@camipacifici camipacifici commented Aug 19, 2022

Description

Added a sentence to the "aperture photometry" plugin docs to tell the user that only standard regions (created with "replace") are acceptable as background regions. Please double check that the link I added takes you here. I am not sure I got it right.

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

@github-actions github-actions bot added the documentation Explanation of code and concepts label Aug 19, 2022
@codecov
Copy link

codecov bot commented Aug 19, 2022

Codecov Report

Merging #1589 (634f0e6) into main (4ee66f2) will not change coverage.
The diff coverage is n/a.

❗ Current head 634f0e6 differs from pull request most recent head e55f0bf. Consider uploading reports for the commit e55f0bf to get more accurate results

@@           Coverage Diff           @@
##             main    #1589   +/-   ##
=======================================
  Coverage   85.74%   85.74%           
=======================================
  Files          94       94           
  Lines        9290     9290           
=======================================
  Hits         7966     7966           
  Misses       1324     1324           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

docs/imviz/plugins.rst Outdated Show resolved Hide resolved
@kecnry kecnry added the no-changelog-entry-needed changelog bot directive label Aug 19, 2022
@kecnry kecnry added this to the 2.9 milestone Aug 19, 2022
@kecnry kecnry added the trivial Only needs one approval instead of two label Aug 19, 2022
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.

LGMT (see rendered docs)

Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

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

LGTM too. Thanks!

Cami, if you have a JIRA ticket for this, pls update it accordingly after merge.

@pllim
Copy link
Contributor

pllim commented Aug 19, 2022

No need to wait for CI since this is only doc change. I will cancel CI and use admin override to merge.

@camipacifici
Copy link
Contributor Author

There was no jira ticket, sorry.

@pllim pllim merged commit 2c8d971 into spacetelescope:main Aug 19, 2022
@camipacifici camipacifici deleted the regions-background-docs branch March 27, 2024 19:21
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 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