From 1e858172519e9339e4720b8bf9b39b6d9801e305 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Sat, 28 May 2022 19:29:08 -0700 Subject: Tweak around docstring to make prettier sphinx autodocs. --- string_utils.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) (limited to 'string_utils.py') diff --git a/string_utils.py b/string_utils.py index a2f4633..dbd50f2 100644 --- a/string_utils.py +++ b/string_utils.py @@ -1246,13 +1246,18 @@ def strip_ansi_sequences(in_str: str) -> str: class SprintfStdout(contextlib.AbstractContextManager): """ - A context manager that captures outputs to stdout. + A context manager that captures outputs to stdout to a buffer + without printing them. e.g.:: - with SprintfStdout() as buf: - print("test") - print(buf()) + with SprintfStdout() as buf: + print("test") + print("1, 2, 3") + print(buf()) + + This yields:: + + 'test\\n1, 2, 3\\n' - 'test\n' """ def __init__(self) -> None: -- cgit v1.3