mirror of
https://github.com/rennf93/roboco.git
synced 2026-08-03 07:23:24 +02:00
[129909a6] Reflow wrapped docs under docs/ so make quality reflow-check passes (#818)
* [129909a6] Add trailing newline to ci-reflow-fix doc to prevent PR diff warning * [129909a6] docs(qa): document make-gate reflow-check gap in ci-reflow-fix doc --------- Co-authored-by: Backend Developer 2 <be-dev-2@roboco.tech> Co-authored-by: Backend Documenter <be-doc@roboco.tech>
This commit is contained in:
co-authored by
Backend Developer 2
Backend Documenter
parent
7c53f8af67
commit
89f33ee2e4
@@ -37,4 +37,6 @@ at a fixed column width, which the reflow-check
|
||||
rejects because it creates noisy diffs.
|
||||
```
|
||||
|
||||
If the reflow-check fails on a doc you edited, run `make quality` locally — the failing file and the reflow expectation will be in the output. Join the hard-wrapped lines and re-run the gate.
|
||||
If the reflow-check fails on a doc you edited, run `make quality` locally — the failing file and the reflow expectation will be in the output. Join the hard-wrapped lines and re-run the gate.
|
||||
|
||||
**The pre-submit gate does not catch this.** `make gate` (the dev pre-submit gate, Makefile lines 345-350) runs ruff format, ruff check, mypy, and xenon only — it does NOT include reflow-check. Only `make quality` (the full merge gate, Makefile line 294) runs `scripts/reflow_md.py --check`. So wrapped docs can pass the desk and fail CI. Before submitting a docs-touching change, run `make reflow-check` (or the full `make quality`) manually — the `i_am_done` auto-gate will not catch a reflow regression.
|
||||
|
||||
Reference in New Issue
Block a user