Commit 2810c20
docs(testing): align aggregation-bits vectors with doc-writer conventions (#919)
* docs(testing): align aggregation-bits vectors with doc-writer conventions
Follow-up to #899. Brings the aggregation-bits bounds vectors in line
with the consensus test-vector documentation standard:
- Drop all inline body comments from the test vectors; the
Given/When/Then docstring is the single source of truth.
- Strip the "a client that..." narration from every Then section so it
states only the asserted outcome (rejection reason or post-state).
- Move the bitfield layout and SSZ-encoding rationale into Given as
atomic facts, and note the bitfield-limit vs registry distinction.
- Tighten the aggregation_bits field and resolver docstrings to terse
one-sentence-per-line phrasing.
- Note in process_attestations that signature verification normally
rejects an out-of-range bit first, so this guards the unsigned path.
- Make is_final_block keyword-only on the block builder.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* docs(testing): use bullets for the aggregation_bits field docstring
Per the doc-writer rules, render the field's three behaviors as bullet
points instead of prose, and fix the summary line so it describes the
default (derived) case rather than only the verbatim override.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>1 parent 3e90d00 commit 2810c20
4 files changed
Lines changed: 18 additions & 34 deletions
File tree
- packages/testing/src/consensus_testing
- test_fixtures
- test_types
- src/lean_spec/spec/forks/lstar
- tests/consensus/lstar/state_transition
Lines changed: 1 addition & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
199 | 199 | | |
200 | 200 | | |
201 | 201 | | |
| 202 | + | |
202 | 203 | | |
203 | 204 | | |
204 | 205 | | |
| |||
Lines changed: 5 additions & 11 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
161 | 161 | | |
162 | 162 | | |
163 | 163 | | |
164 | | - | |
| 164 | + | |
165 | 165 | | |
166 | | - | |
167 | | - | |
168 | | - | |
169 | | - | |
170 | | - | |
171 | | - | |
172 | | - | |
173 | | - | |
174 | | - | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
175 | 169 | | |
176 | 170 | | |
177 | 171 | | |
178 | | - | |
| 172 | + | |
179 | 173 | | |
180 | 174 | | |
181 | 175 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
456 | 456 | | |
457 | 457 | | |
458 | 458 | | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
459 | 462 | | |
460 | 463 | | |
461 | 464 | | |
| |||
Lines changed: 9 additions & 23 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
31 | | - | |
| 30 | + | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
41 | | - | |
42 | | - | |
43 | 40 | | |
44 | 41 | | |
45 | 42 | | |
| |||
48 | 45 | | |
49 | 46 | | |
50 | 47 | | |
51 | | - | |
52 | | - | |
53 | 48 | | |
54 | 49 | | |
55 | 50 | | |
| |||
89 | 84 | | |
90 | 85 | | |
91 | 86 | | |
92 | | - | |
93 | | - | |
94 | | - | |
95 | 87 | | |
96 | 88 | | |
97 | 89 | | |
| |||
128 | 120 | | |
129 | 121 | | |
130 | 122 | | |
| 123 | + | |
131 | 124 | | |
132 | 125 | | |
133 | 126 | | |
| |||
136 | 129 | | |
137 | 130 | | |
138 | 131 | | |
139 | | - | |
140 | | - | |
141 | | - | |
142 | 132 | | |
143 | 133 | | |
144 | 134 | | |
| |||
173 | 163 | | |
174 | 164 | | |
175 | 165 | | |
176 | | - | |
177 | | - | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
178 | 169 | | |
179 | 170 | | |
180 | 171 | | |
181 | 172 | | |
182 | 173 | | |
183 | 174 | | |
184 | 175 | | |
185 | | - | |
186 | | - | |
187 | | - | |
188 | | - | |
189 | | - | |
190 | | - | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
191 | 179 | | |
192 | 180 | | |
193 | 181 | | |
| |||
196 | 184 | | |
197 | 185 | | |
198 | 186 | | |
199 | | - | |
200 | | - | |
201 | 187 | | |
202 | 188 | | |
203 | 189 | | |
| |||
0 commit comments