Skip to content

Commit

Permalink
bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1976)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
gfyoung authored and Mariatta committed Jun 6, 2017
1 parent 2bafc0d commit 063f0b3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Doc/howto/clinic.rst
Expand Up @@ -1407,8 +1407,8 @@ Let's start with defining some terminology:

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

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

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

0 comments on commit 063f0b3

Please sign in to comment.