Skip to content

Commit 59fd54f

Browse files
mforbesMichael McNeil Forbes
andauthored
DOCS: clarify meaning of merge_streams option (#664) (#665)
Co-authored-by: Michael McNeil Forbes <michael.forbes+python@gmail.com>
1 parent 27c82f3 commit 59fd54f

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

docs/render/format_code_cells.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,18 @@ This can be set to:
8484
(render/output/group-stderr-stdout)=
8585
### Group into single streams
8686

87-
Cells may print multiple things to `stdout` and `stderr`.
87+
Cells may print multiple things to `stdout` (and/or to `stderr`).
8888
For example, if a cell prints status updates throughout its execution, each of these is often printed to `stdout`.
8989
By default, these outputs may be split across multiple items, and will be rendered as separate "chunks" in your built documentation.
9090

91-
If you'd like each of the outputs in `stderr` and `stdout` to be merged into a single stream for each, use the following configuration:
91+
If you'd like each of the outputs in `stdout` to be merged into a single stream for each, use the following configuration (see {ref}`config/intro`):
9292

9393
```python
9494
nb_merge_streams = True
9595
```
9696

97-
This will ensure that all `stderr` and `stdout` outputs are merged into a single group.
97+
This will ensure that all `stdout` outputs are merged into a single group; likewise, all
98+
`stderr` outputs will be merged into single (separate) group.
9899
This also makes cell outputs more deterministic.
99100
Normally, slight differences in timing may result in different orders of `stderr` and `stdout` in the cell output, while this setting will sort them properly.
100101

myst_nb/core/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ def __post_init__(self):
285285
default=False,
286286
metadata={
287287
"validator": instance_of(bool),
288-
"help": "Merge stdout/stderr execution output streams",
288+
"help": "Merge all stdout execution output streams; same with stderr",
289289
"sections": (
290290
Section.global_lvl,
291291
Section.file_lvl,

0 commit comments

Comments
 (0)