Repository navigation
Prose cleanup since 0.63.0: comments and docs - #1358
Merged
Merged
Conversation
Remove comments that restate code, narrate history or quote one-run measurements; cut over-budget docstrings to the constraint they carry. AST-identical with docstrings stripped, except two tooltip strings (Edit Toolbar hint, Diffusion). WGSL code unchanged.
USER_GUIDE -18%, PIPELINE -15%, CAMERA_SCANNING/CROSSTALK/README/ CONTRIBUTING ~-20%, the rest lighter. Panel markers, headings, links, formulas, constants and citations kept. crosstalk/README now shows the current process values (Color Negative / Transparency); the guide's Pakon model list matches the loader.
# Conflicts: # docs/PIPELINE.md # docs/USER_GUIDE.md # negpy/desktop/controller.py # negpy/features/flatfield/logic.py # negpy/services/rendering/image_processor.py
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
1 participant
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.
Cleanup pass over prose added since the 0.63.0 tag, plus a whole-file pass over the docs.
Code comments (99 files, −445 lines)
ast.dumpof HEAD vs branch is identical with docstrings stripped, for every file except two intentional UI strings:canvas/toolbar.py)sidebar/tone.py), dropped one clause//comments stripped is identical.noqa/type: ignore/fmt:pragmas unchanged.Docs
panel:markers stay above unchanged headings. Headings, links, formulas, constants and patent/literature citations are kept.C41/E-6as the currentprocessvalues (they areColor Negative/Transparency), and the guide listed a Pakon F235 that the loader does not know. FILTERING "Behaviour" → "Behavior". Emoji removed from CONTRIBUTING headings (no links point to them)..claude/skills.To check
test_autocrop_state_table.pyno longer points to the out-of-repo "Auto Crop plan", which explained the E19/P3 test ids.make all: 8682 passed, lint and type clean.