Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-29596: Improve clinic howto documentation (GH-1710) 

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.
This commit is contained in:
gfyoung 2017-06-06 15:23:52 -04:00 committed by Mariatta
parent 53f2af1655
commit ec19ba210b
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/howto/clinic.rst
View File

@ -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.
@ -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