Enforce canonical Markdown formatting. - #77
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ba66e0d9e2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
A line-length check cannot catch paragraphs stranded across short lines, and MD013's default mode lets a final word cross the configured limit. Require pinned Prettier formatting for tracked Markdown in CI and enable MD013's stern mode to enforce wrappable prose length. Wrap prose at 80 columns and normalize Markdown structure and LF line endings. Leave embedded code formatting disabled and preserve MD013's code-block, table, unbreakable-token, and link-only exemptions. Apply the format and use reference links where inline destinations prevent wrapping. Document the local commands while keeping PR paragraphs unwrapped. Parse reference definitions so wrapped destinations retain the same local-path and anchor checks as single-line definitions.
ba66e0d to
d99ed01
Compare
|
@codex review |
|
Codex Review: Didn't find any major issues. Breezy! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
1 participant
Format tracked Markdown with pinned Prettier 3.9.9 and reject formatting drift in CI. Use
proseWrap: "always",printWidth: 80, and LF line endings. Prettier also normalizes headings, lists, tables, and spacing. Embedded code formatting is disabled.Why
A line-length check cannot catch a paragraph stranded across short lines, and MD013's default mode lets a final word cross column 80. Prettier gives paragraphs a reproducible layout; MD013's
sternmode enforces the prose limit while retaining its exemptions for code blocks, tables, unbreakable tokens, and link-only lines. Long inline destinations become reference links where necessary for wrapping. The policy checker parses reference definitions so it still checks local paths and anchors when Prettier puts the destination on the next line.Documentation
Apply the formatter to the tracked Markdown and document the local formatting commands in the contribution guide. The reflow preserves rendered content and link destinations, and existing code examples are unchanged. Pull-request descriptions keep their existing one-line-per-paragraph rule.