Skip to content

doc: enforce 80-char line wrap in Markdown docs#1828

Draft
candleindark wants to merge 1 commit intodandi:masterfrom
candleindark:doc-claude-md-80char-wrap
Draft

doc: enforce 80-char line wrap in Markdown docs#1828
candleindark wants to merge 1 commit intodandi:masterfrom
candleindark:doc-claude-md-80char-wrap

Conversation

@candleindark
Copy link
Copy Markdown
Member

Summary

  • Add instruction to CLAUDE.md to wrap all Markdown and human-readable
    documentation files at 80 characters per line, for better readability
    in terminals, editors, and side-by-side diffs.
  • Reformat CLAUDE.md itself to comply with the new rule.

Test plan

  • CLAUDE.md updated with the new documentation guideline
  • CLAUDE.md reformatted to 80-char line width

🤖 Generated with Claude Code

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>
@candleindark candleindark added the documentation Changes only affect the documentation label Apr 2, 2026
@candleindark candleindark requested a review from yarikoptic April 2, 2026 07:02
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.12%. Comparing base (fb5e2f0) to head (61ae886).

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     
Flag Coverage Δ
unittests 75.12% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@yarikoptic
Copy link
Copy Markdown
Member

why would I like this? I would prefer one sentence a line

@yarikoptic
Copy link
Copy Markdown
Member

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

@yarikoptic yarikoptic marked this pull request as draft April 2, 2026 18:48
@candleindark
Copy link
Copy Markdown
Member Author

formatting into specific width causes then problems since different editors might rewrap differently etc.

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

dandi-cli/CLAUDE.md

Lines 15 to 17 in fb5e2f0

- Due to use of `pre-commit` with black and other commands which auto-fix, if changes
were reported to be done, just rerun commit again 2nd time, and if only then if still
does not commit analyze output more
and other places. All this PR does is ask to AI agent to enforce a specific line length in hard wrapping.

I would prefer one sentence a line

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.

@yarikoptic
Copy link
Copy Markdown
Member

formatting into specific width causes then problems since different editors might rewrap differently etc.

Are you talking about soft rewrap by an editor? If you are, I don't see that it is a problem.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes only affect the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants