summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgfyoung <gfyoung17@gmail.com>2017-06-06 21:17:18 (GMT)
committerMariatta <Mariatta@users.noreply.github.com>2017-06-06 21:17:18 (GMT)
commit063f0b358331322d84f85008e6c01f80ff321fd6 (patch)
tree17bc7319d2aac3fbf719db4b936ab64bad5cfedc
parent2bafc0dccac2390a52670ba289878318b6ea0293 (diff)
downloadcpython-063f0b358331322d84f85008e6c01f80ff321fd6.zip
cpython-063f0b358331322d84f85008e6c01f80ff321fd6.tar.gz
cpython-063f0b358331322d84f85008e6c01f80ff321fd6.tar.bz2
bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1976)
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.
-rw-r--r--Doc/howto/clinic.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/howto/clinic.rst b/Doc/howto/clinic.rst
index eaab20a..083a299 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