Fix suggest_transform docstring to match POWER fallback logic#90
Open
kgdunn wants to merge 3 commits into
Open
Fix suggest_transform docstring to match POWER fallback logic#90kgdunn wants to merge 3 commits into
kgdunn wants to merge 3 commits into
Conversation
The previous docstring said the POWER branch fires for 'milder skew', but both LOG and POWER branches use the same skewness > 1.0 threshold. POWER is reached when the variable is strongly skewed but is not strictly positive or lacks a wide dynamic range. Update the docstring to describe the actual rule.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
The docstring for
suggest_transforminsrc/scorepilot/core/profiling.pymisdescribes the rule used by the function. It says the POWER branch is reached for "milder skew", but in reality the POWER branch fires at exactly the sameskewness > 1.0threshold as the LOG branch. What actually differs between the two branches is the positive + wide_range conditions, not the skew level.This PR replaces the rule paragraph with an accurate description of the implemented logic:
Surgical docstring-only change; no behaviour change. PATCH version bump in
pyproject.tomlper the repo versioning rule.Test plan
uv run ruff check src/scorepilot/core/profiling.pyuv run ruff format --check src/scorepilot/core/profiling.pyGenerated by Claude Code