Skip to content

Commit ee9de30

Browse files
gfyoungMariatta
authored andcommitted
bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1975)
Clarify that `two-pass` buffer can only be dumped once, and it prints out all text sent to it during all processing, even from Clinic blocks *after* the dumping point.
1 parent 86f8f1f commit ee9de30

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Doc/howto/clinic.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1407,8 +1407,8 @@ Let's start with defining some terminology:
14071407

14081408
``two-pass``
14091409
A buffer like ``buffer``. However, a two-pass buffer can only
1410-
be written once, and it prints out all text sent to it during
1411-
all of processing, even from Clinic blocks *after* the
1410+
be dumped once, and it prints out all text sent to it during
1411+
all processing, even from Clinic blocks *after* the dumping point.
14121412

14131413
``suppress``
14141414
The text is suppressed—thrown away.
@@ -1471,7 +1471,7 @@ preset configurations, as follows:
14711471
The default filename is ``"{dirname}/clinic/{basename}.h"``.
14721472

14731473
``buffer``
1474-
Save up all most of the output from Clinic, to be written into
1474+
Save up most of the output from Clinic, to be written into
14751475
your file near the end. For Python files implementing modules
14761476
or builtin types, it's recommended that you dump the buffer
14771477
just above the static structures for your module or

0 commit comments

Comments
 (0)