chore: remove verbose comments and simplify code#20
Merged
Conversation
Expands from 3 pages to 8, with explicit audience split (template users vs authors), example-first content style, and low-maintenance structure. Based on research of cookiecutter, copier, just, ghostty, and starship docs.
10-task plan covering scaffold, 8 content pages, and final review. Example-first style, progressive disclosure, consistent reference format across all pages.
Remove "what" comments that restate code, trivial doc comments on obvious structs/fields/functions, and numbered step comments. Keep "why" comments and docs that add non-obvious context. Minor code simplifications (collapsed else-if, format!→to_string).
Deploying diecut with
|
| Latest commit: |
e5c5da9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6ffbf59f.diecut.pages.dev |
| Branch Preview URL: | https://chore-cleanup-verbosity.diecut.pages.dev |
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.
Summary
when/computedfield semantics, three-way merge algorithm description, safety notes)else { if }toelse if,format!("{}", x)tox.to_string()Net change: -312 lines, +36 lines across both crates.
Test plan
cargo fmt --checkpassescargo clippy -- -D warningspasses