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.

Sign up for GitHub

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

Jump to bottom

DOC: Clarify centroid subtlety #1854

Merged
merged 2 commits into from
Nov 18, 2022
Merged

DOC: Clarify centroid subtlety #1854

merged 2 commits into from
Nov 18, 2022

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Nov 17, 2022 •
edited
Loading

Description

This pull request is to clarify centroid subtlety that it requires background subtraction to be accurate.

Related PRs:

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

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 milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)? 🐱

@pllim
DOC: Clarify centroid subtlety
8a4b34c 
that requires background subtraction.
@pllim pllim added documentation Explanation of code and concepts imviz no-changelog-entry-needed changelog bot directive labels Nov 17, 2022
@pllim pllim added this to the 3.2 milestone Nov 17, 2022
@codecov
Copy link

codecov bot commented Nov 17, 2022 •
edited
Loading

Codecov Report

Base: 88.29% // Head: 88.29% // No change to project coverage 👍

Coverage data is based on head (5f7a96d) compared to base (e841613).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1854   +/-   ##
=======================================
  Coverage   88.29%   88.29%           
=======================================
  Files          95       95           
  Lines       10396    10396           
=======================================
  Hits         9179     9179           
  Misses       1217     1217

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

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@pllim @larrybradley
Add hyphen
5f7a96d 
Co-authored-by: Larry Bradley <[email protected]>
rosteen
rosteen approved these changes Nov 18, 2022
View reviewed changes
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!

@pllim
Copy link
Contributor Author

pllim commented Nov 18, 2022

@larrybradley , you happy with the wordings now?

larrybradley
larrybradley approved these changes Nov 18, 2022
View reviewed changes
Copy link
Member

@larrybradley larrybradley left a comment

Choose a reason for hiding this comment

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

LGTM

@pllim pllim merged commit 64ba6b1 into spacetelescope:main Nov 18, 2022
@pllim pllim deleted the one-does-not-simply-centroid branch November 18, 2022 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rosteen rosteen rosteen approved these changes

@larrybradley larrybradley larrybradley approved these changes

@camipacifici camipacifici Awaiting requested review from camipacifici

@duytnguyendtn duytnguyendtn Awaiting requested review from duytnguyendtn

@javerbukh javerbukh Awaiting requested review from javerbukh javerbukh is a code owner

@ojustino ojustino Awaiting requested review from ojustino

@kecnry kecnry Awaiting requested review from kecnry kecnry is a code owner

@bmorris3 bmorris3 Awaiting requested review from bmorris3 bmorris3 is a code owner

Assignees
No one assigned
Labels
documentation Explanation of code and concepts imviz no-changelog-entry-needed changelog bot directive
Projects
None yet
Milestone
3.2
Development

Successfully merging this pull request may close these issues.
3 participants
@pllim @larrybradley @rosteen