u/parejkoj/multiplier-docstring: Clarify multiplier docstring #356
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
laurenam
reviewed
Nov 19, 2023
| dtype=float, optional=False, default=5.0, min=0.0, | ||
| ) | ||
| includeThresholdMultiplier = pexConfig.RangeField( | ||
| doc="Include threshold relative to thresholdValue.", | ||
| doc="Multiplier on thresholdValue for whether a source is included in the output catalog. " | ||
| "For example, value=5, multiplier=10 results in a catalog of sources at >50 sigma, " |
There was a problem hiding this comment.
I'd just use the actual config names here, i.e. value -> thresholdValue and multiplier -> includeThresholdMultiplier. Also, I'm not sure sigma is strictly correct given the options for thresholdType.
parejkoj
force-pushed
the
u/parejkoj/multiplier-docstring
branch
from
145ce42 to
b487f3e
Compare
laurenam
approved these changes
Nov 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.