Skip to content

Commit c5f9ca9

Browse files
committed
Improved comment
1 parent 2db18d0 commit c5f9ca9

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

cmd2.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,9 @@ def __init__(self, completekey='tab', stdin=None, stdout=None, use_ipython=False
545545
# Used when piping command output to a shell command
546546
self.pipe_proc = None
547547

548-
# Size of the stdin/stdout buffers used when piping command output to a shell command
548+
# Size of the stdin/stdout buffers used when piping command output to a shell command via self.stdout.
549+
# This should be increased in cases where large amounts of data are expected to be piped to the shell
550+
# to prevent blocking when writing to self.stdout.
549551
self._pipe_buffer_size = io.DEFAULT_BUFFER_SIZE
550552

551553
# ----- Methods related to presenting output to the user -----

0 commit comments

Comments
 (0)