From: gfyoung Date: Tue, 6 Jun 2017 21:38:08 +0000 (-0400) Subject: bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1975) X-Git-Tag: v3.5.4rc1~106 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ee9de30aa0dbcfd848e4200944674a084d963588;p=thirdparty%2FPython%2Fcpython.git 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. --- diff --git a/Doc/howto/clinic.rst b/Doc/howto/clinic.rst index 491c5a2ca4c6..8b2fc7453b24 100644 --- a/Doc/howto/clinic.rst +++ b/Doc/howto/clinic.rst @@ -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