bpo-29596: Improve clinic howto documentation (GH-1710)
authorgfyoung <gfyoung17@gmail.com>
Tue, 6 Jun 2017 19:23:52 +0000 (15:23 -0400)
committerMariatta <Mariatta@users.noreply.github.com>
Tue, 6 Jun 2017 19:23:52 +0000 (12:23 -0700)
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.

Doc/howto/clinic.rst

index b5c14d3af072be5f2d9568e372cf52d0a95441a5..d3c7d668959e56e92be4004bb9af89882cc06347 100644 (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