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

DM-34531: Fix incorrect RangeField docstrings #71

Merged
merged 1 commit into from Jun 1, 2022
Merged

Conversation

parejkoj
Copy link
Contributor

@parejkoj parejkoj commented Apr 22, 2022

I noticed this when adding a RangeField to meas_extensions_piff: the stated default for inclusiveMax in the docs didn't match the default value in the kwarg list, so I removed the redundant "(default)" lines.

@codecov
Copy link

codecov bot commented Apr 22, 2022

Codecov Report

Merging #71 (f8d61d0) into main (2161031) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #71   +/-   ##
=======================================
  Coverage   83.68%   83.68%           
=======================================
  Files          40       40           
  Lines        2972     2972           
=======================================
  Hits         2487     2487           
  Misses        485      485           
Impacted Files Coverage Δ
python/lsst/pex/config/rangeField.py 87.50% <ø> (ø)

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 2161031...f8d61d0. Read the comment docs.

@parejkoj parejkoj changed the title DM-34531: Make piff PSF model size configurable DM-34531: Fix incorrect RangeField docstrings Apr 22, 2022
@parejkoj
Copy link
Contributor Author

parejkoj commented Jun 1, 2022

@timj : tiny review request here, since it's independent of the original ticket which might take a lot longer.

Copy link
Member

@timj timj left a comment

Choose a reason for hiding this comment

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

I think removing the "default" is okay since Sphinx will report the defaults. (and yes, the one for inclusiveMax is actually documented with the wrong default).

@parejkoj parejkoj merged commit 8061f95 into main Jun 1, 2022
@parejkoj parejkoj deleted the tickets/DM-34531 branch June 1, 2022 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants