docs: fix suggest_transform / apply_transform / Settings docstrings - #104
Open
kgdunn wants to merge 1 commit into
Open
docs: fix suggest_transform / apply_transform / Settings docstrings#104kgdunn wants to merge 1 commit into
kgdunn wants to merge 1 commit into
Conversation
- suggest_transform: describe the actual branching (both branches require skewness > 1; LOG needs positivity + wide range, POWER catches the rest) instead of the incorrect 'milder skew' wording. - apply_transform: describe the real POWER default. The signature default is c1=0.0 and _transform_values special-cases 0.0 -> 0.5, so the previous 'default c1 = 0.5' description was wrong. Also note c2 is unused. - Settings: extend the Attributes block to document auth_username / auth_password, docs_enabled, max_upload_mb, max_cells so the class docstring matches the fields the class actually declares. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017eNvkh6WTyBeTt4fTVxmUr
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
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.
Three surgical docstring fixes where the prose had drifted from the code.
1.
src/scorepilot/core/profiling.py—suggest_transform(line 142)The docstring described a "milder skew" branch, but the code has no such branch: both the LOG and POWER paths require
strongly_skewed = summary.skewness > 1.0. The POWER branch is entered when a strongly-skewed variable fails either the positivity or the wide-range check, not when the skew is milder.Rewritten to describe the actual branching, including the numeric thresholds (
skewness > 1,min_max_ratio > 20) that the code applies.2.
src/scorepilot/core/transforms.py—apply_transform(line 17)The
Notesbullet forpowerclaimed the default wasc1 = 0.5giving a signed root, but the signature default isc1: float = 0.0. The signed-root default actually comes from_transform_values, which special-cases0.0 → 0.5:Rewrote the bullet to describe that behaviour explicitly and to note that
c2is ignored by this branch.3.
src/scorepilot/config.py—Settingsclass (line 15)The
Attributesblock documenteddatabase_url,host,port,open_browser, and the four agent settings, but omitted the hardening knobs added later. Addedauth_username/auth_password,docs_enabled,max_upload_mb, andmax_cellswith descriptions matching the inline comments already on the fields.Version
Bumped
pyproject.tomlfrom0.22.0→0.22.1(PATCH — docs-only) and refresheduv.lockper the repo's CLAUDE.md.Generated by Claude Code