Commit 4a5d681
committed
docs(style): the test is an interrogative word, not a question mark
Chapter 00's section headings `背景:模块到了,工具链没跟上` and
`谁在为这个落差付账`, and the analogy table's column header
`大致相当于谁的活`, are all colloquial, all violate the register rule, and all
passed check_docs_style.sh. Two independent defects in one check.
THE PREDICATE TESTED A MARKER RATHER THAN THE PROPERTY. It matched `?`, 吗 and
呢 -- the punctuation a question usually carries. The property is the
interrogative word, and neither heading carries the marker.
THE OBJECT SET WAS ENUMERATED SYNTACTICALLY. It read lines beginning with `#`.
The property a heading has -- it names a topic, it is read out of order, it is
what a reader scans -- is held equally by a table's header cells, which were
therefore never examined.
- Chapter 00 rewritten. The scope of a background section is decided by the
problem, not by the tool: a C++ project needs four things at once and no
single tool owns all four; CMake is the de facto standard for one of them,
and a de facto standard is a statement about adoption rather than about the
experience of use; the environment is the layer that fails most often because
it is the only one nothing checks. Modules are the fourth constraint on that
structure rather than the structure.
- 100 headings and 57 column headers become noun phrases, in both languages.
- check_docs_style.sh: the predicate is now the interrogative word set, and a
fourth rule covers column headers. Chapter 00's title is exempt by name, with
the reason stated.
- check_docs_structure.sh rule 9 discarded the link fragment, so a link to a
renamed section resolved to the file and passed. It now computes GitHub's
slug and verifies the fragment. It immediately reported two anchors in
chapter 30 that were wrong when they were written.
- The skill records R5 (the scope of a background section), the predicate rule
and the column-header rule, each with this batch's own sentences as the
worked example.
Each of the four new checks was falsified before commit: an interrogative
heading with no question mark, a Chinese column header, an English column
header, and an interrogative inside inline code that must not fire.1 parent c3cebe8 commit 4a5d681
57 files changed
Lines changed: 467 additions & 307 deletions
File tree
- .agents/skills/mcpp-docs-style
- .github/tools
- docs
- specs
- zh
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
98 | | - | |
| 98 | + | |
99 | 99 | | |
100 | 100 | | |
101 | 101 | | |
102 | 102 | | |
103 | 103 | | |
| 104 | + | |
104 | 105 | | |
105 | 106 | | |
106 | 107 | | |
107 | 108 | | |
108 | 109 | | |
109 | | - | |
| 110 | + | |
110 | 111 | | |
111 | 112 | | |
112 | 113 | | |
| |||
159 | 160 | | |
160 | 161 | | |
161 | 162 | | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
162 | 169 | | |
163 | 170 | | |
164 | 171 | | |
165 | 172 | | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
166 | 181 | | |
167 | 182 | | |
168 | 183 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
144 | 144 | | |
145 | 145 | | |
146 | 146 | | |
147 | | - | |
| 147 | + | |
148 | 148 | | |
149 | 149 | | |
150 | 150 | | |
151 | 151 | | |
152 | 152 | | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
153 | 159 | | |
154 | | - | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
155 | 200 | | |
156 | | - | |
157 | | - | |
158 | | - | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
159 | 204 | | |
160 | 205 | | |
161 | | - | |
| 206 | + | |
| 207 | + | |
162 | 208 | | |
163 | 209 | | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
164 | 219 | | |
165 | 220 | | |
166 | 221 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
11 | 18 | | |
12 | 19 | | |
13 | 20 | | |
| |||
43 | 50 | | |
44 | 51 | | |
45 | 52 | | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
46 | 63 | | |
47 | | - | |
48 | | - | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
49 | 72 | | |
| 73 | + | |
| 74 | + | |
50 | 75 | | |
51 | | - | |
52 | | - | |
| 76 | + | |
| 77 | + | |
53 | 78 | | |
54 | 79 | | |
55 | 80 | | |
56 | 81 | | |
57 | 82 | | |
58 | 83 | | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
59 | 116 | | |
60 | 117 | | |
61 | 118 | | |
| |||
0 commit comments