Commit 74c009d
committed
docs(stdlib): add Args and Returns sections to chunker flush overrides
The Docs CI docstring quality gate [no_class_args]-equivalent check
requires every documented method with typed params to have an Args
section and a Returns section matching the return annotation.
SentenceChunker.flush, WordChunker.flush, and ParagraphChunker.flush
all took accumulated_text and returned list[str] without the sections.
Add both to each override, documenting each flush's specific semantics
(rstrip for sentences, whitespace-split trailing fragment for words,
byte-for-byte for paragraphs).
Assisted-by: Claude Code1 parent da41a06 commit 74c009d
1 file changed
Lines changed: 32 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
124 | 124 | | |
125 | 125 | | |
126 | 126 | | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
127 | 136 | | |
128 | 137 | | |
129 | 138 | | |
| |||
177 | 186 | | |
178 | 187 | | |
179 | 188 | | |
180 | | - | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
181 | 204 | | |
182 | 205 | | |
183 | 206 | | |
| |||
232 | 255 | | |
233 | 256 | | |
234 | 257 | | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
235 | 266 | | |
236 | 267 | | |
237 | 268 | | |
| |||
0 commit comments