doc: enforce 80-char line wrap in Markdown docs#1828
doc: enforce 80-char line wrap in Markdown docs#1828candleindark wants to merge 1 commit intodandi:masterfrom
Conversation
Add instruction to wrap all Markdown and human-readable documentation files at 80 characters per line to improve readability for humans viewing the files in terminals, editors, or side-by-side diffs. Reformat CLAUDE.md itself to comply with the new rule. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1828 +/- ##
==========================================
- Coverage 75.13% 75.12% -0.01%
==========================================
Files 84 84
Lines 11931 11931
==========================================
- Hits 8964 8963 -1
- Misses 2967 2968 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
why would I like this? I would prefer one sentence a line |
|
formatting into specific width causes then problems since different editors might rewrap differently etc. It is not like we have black reformatting for them set up. If you find trustworthy reformatted for markdown files, then let's consider. For now - moving into draft |
Are you talking about soft rewrap by an editor? If you are, I don't see that it is a problem. My concern is that the diff of a very long line is not that as easy to read that a shorter line. Additionally, there is already hard wrapping going on as in Lines 15 to 17 in fb5e2f0
To achieve that, we think will need to instruct the AI agent to do that or "find trustworthy reformatted for markdown files" that allow that configuration. The current setup doesn't ensure that though. |
no -- I meant hard rewrap like you did. E.g. I change one word, I would need to rewrap, changing potentially formatting of an entire huge paragraph although it was a letter change.. what we have
overall -- I am ok for us all to agree to some and follow, but not 1 file change at a time and not to 80 since I find it too narrow these days. |
Summary
documentation files at 80 characters per line, for better readability
in terminals, editors, and side-by-side diffs.
Test plan
🤖 Generated with Claude Code