docs: a pregate-literal reason cannot start with * (GST-634 docs audit)

Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
This commit is contained in:
garrytanandcapy-ai[bot] committed 2026-11-02 19:58:03 +00:00
1 parent ed69fe8271
commit 0ac7db5618
1 file changed
+3 -2
+3 -2
View File
@@ -233,8 +233,9 @@ Two stages with separate clocks, both printed:
comment line directly above it: comment line directly above it:
`// pregate-literal: MIN_RUNTIME='1.4.0' refused input below the minimum` `// pregate-literal: MIN_RUNTIME='1.4.0' refused input below the minimum`
(`#` and `/*` comments work too). The marker waives only that line, and only (`#` and `/*` comments work too). The marker waives only that line, and only
when it names the changed constant and its old value and gives a reason; text when it names the changed constant and its old value and gives a reason (a
inside a string is not a marker. Every other line in the file is still reason cannot start with `*`, so a bare `*/`, `**/` or `* */` closer is not
one); text inside a string is not a marker. Every other line in the file is still
checked. The check lists each waived line as checked. The check lists each waived line as
`waived: <file>:<line>: <NAME> <old> (<reason>)`, adding `marker added on `waived: <file>:<line>: <NAME> <old> (<reason>)`, adding `marker added on
this branch` when the merge-base file lacks the marker. The policy has no this branch` when the merge-base file lacks the marker. The policy has no