Skip to content

Commit 79b3027

Browse files
Trim redundant parameter prose from decode_text docstring
The signature already conveys what max_size and label do; keep only the non-obvious caveats about the errors handler and embedded-NUL truncation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 2264e01 commit 79b3027

1 file changed

Lines changed: 0 additions & 1 deletion

File tree

src/dqlitewire/types.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,6 @@ def decode_text(
254254
) -> tuple[str, int]:
255255
"""Decode NUL-terminated UTF-8 text; return (text, bytes_consumed).
256256
257-
``max_size`` caps decoded length; ``label`` names the field in errors.
258257
``errors="replace"``/``"surrogateescape"`` yield codepoints the log
259258
sanitiser misses and that break encode_text round-trip. Embedded NULs in
260259
server data read back truncated at the first NUL (no length prefix).

0 commit comments

Comments
 (0)