Repository navigation
chore: enforce 80-column Markdown prose wrapping - #530
Merged
Merged
Conversation
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
11 tasks done
nvzhihanj
approved these changes
Oct 8, 2026
nv-alicheng
approved these changes
Oct 8, 2026
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
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.
What does this PR do?
Wrap Markdown prose at 80 columns with Prettier's
proseWrap: alwaysandprintWidth: 80, scoped to Markdown in.prettierrc.yaml. Long paragraphsare automatically reflowed by the existing pre-commit hook; the existing
Pre-commit GitHub Actions workflow runs that same hook on all tracked files
and fails when formatting changes are needed.
Reformat the existing Markdown files so the rule can take effect immediately,
and document the policy and formatting command in the development guide and
agent instructions. Tables, code blocks, and indivisible links or inline code
may exceed the target width. This is a prose-wrapping policy, not a hard limit
on every Markdown source line.
Type of change
Testing
.mdand nested.markdownfiles failsthe hook, is wrapped to at most 80 columns, and passes on the second run.
all 59 formatting-only files; no differences other than prose whitespace.
The two files with intentional documentation additions were reviewed separately.
git diff --checkuv run pre-commit run --all-files: all hooks passed except macOSmypy errors for Linux-only
os.sched_setaffinity/os.sched_getaffinityin unchanged source files. Re-ran the same mypy environment with
--platform linux(the CI platform): all 333 source files passed.Checklist