bpo-29596: Fix missing documentation in clinic.rst #1710
Conversation
|
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA). Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. Thanks again to your contribution and we look forward to looking at it! |
Doc/howto/clinic.rst
Outdated
| @@ -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 almost all of the output from Clinic, to be written into | |||
There was a problem hiding this comment.
“Save up most of . . .” would be simpler I think, assuming that’s what @larryhastings meant. But that leaves the question of what is and isn’t saved. Next paragraph mentions suppressing some stuff, but only writing stuff to block and file, which doesn’t help me. Perhaps file should be buffer?
Doc/howto/clinic.rst
Outdated
| @@ -1408,7 +1408,7 @@ 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 | |||
| all of processing, even from Clinic blocks *after* the current one. | |||
There was a problem hiding this comment.
My guess is @larryhastings meant after the dumping point.
Of should also be removed from “during all [of] processing”.
And would it be better to say “a two-pass buffer can only be dumped once”? Otherwise it sounds like you can only use the two-pass destination once, and then you have to use some other destination.
|
@vadmium : Do you have any updates on this? |
|
No further comments from me |
|
Thanks for the PR 🎉 |
|
@Mariatta : PR's up for backporting. |
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.
Title is self-explanatory. If this patch is accepted, I can also backport to the 3.5 and 3.6 branches.