Skip to content

docs(claude): size help-text prose to the behavior's share of the command - #3772

Merged
max-sixty merged 1 commit into
mainfrom
docs/help-length-proportional-31257485200
Aug 8, 2026
Merged

docs(claude): size help-text prose to the behavior's share of the command#3772
max-sixty merged 1 commit into
mainfrom
docs/help-length-proportional-31257485200

Conversation

@worktrunk-bot

Copy link
Copy Markdown
Collaborator

Requested in review feedback on #3770:

this is way too verbose; create another PR to add guidance to have the share of the docs proportional to the share of the feature.

in this case it's a tiny share of the feature and probably have zero docs; it's implicit

The existing content principles in docs/CLAUDE.md govern what a piece of help text says and where it starts, but nothing says how much a behavior earns. That gap is what produced the paragraph the review was reading: a narrow refusal in wt remove got a full paragraph on the command's help page, ahead of behavior every user of the command meets. New principle 5 makes the sizing rule explicit, including the zero case — an edge case whose own error message states it at the moment it matters is left implicit.

The paragraph that prompted this is already gone from #3770 (30ba949).

@max-sixty
max-sixty merged commit ca54dde into main Aug 8, 2026
37 checks passed
@max-sixty
max-sixty deleted the docs/help-length-proportional-31257485200 branch August 8, 2026 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants