This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Unfinished sentence in howto/clinic.rst
Type: Stage: resolved
Components: Argument Clinic, Documentation Versions: Python 3.7, Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Mariatta, Steven Rumbalski, docs@python, larry, martin.panter, mbussonn
Priority: normal Keywords:

Created on 2017-02-18 01:12 by mbussonn, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 1710 merged gfyoung, 2017-05-22 01:55
PR 1975 merged gfyoung, 2017-06-06 20:32
PR 1976 merged gfyoung, 2017-06-06 20:34
Messages (7)
msg288048 - (view) Author: Matthias Bussonnier (mbussonn) * Date: 2017-02-18 01:12
Around line 1400 of Doc/howto/clinic.rst

  ``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

I've rarely be kept in such suspense ! Unless it's a reference to Monty Python's "The Man Who Finishes Other People's Sentences". In which case, I must say it's
msg288532 - (view) Author: Steven Rumbalski (Steven Rumbalski) Date: 2017-02-24 20:33
Truncated sentence was always truncated.

Introduced on commit bebf73511a1250fc768bcb7192b5b3c3fd04d8f2
from Issue #20287: Argument Clinic's output is now configurable, allowing
delaying its output or even redirecting it to a separate file.
https://github.com/python/cpython/commit/bebf73511a1250fc768bcb7192b5b3c3fd04d8f2

Another issue from the same commit that still exists today:

buffer
    Save up all most of the output from Clinic, to be written into your file near the end.
            ^^^^^^^^

Perhaps what was meant was 'almost all'?
msg294737 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2017-05-30 04:36
Currently for the “buffer” destination, it says

Suppress . . ., write . . . to ``block``, and write everything else to ``file``.

Would it be more correct to change “file“ to “buffer”? I.e.

Suppress . . ., write . . . to ``block``, and write everything else to ``buffer``.
msg295294 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-06-06 19:23
New changeset ec19ba210bba2c3097232a05d7dbe093beb5f833 by Mariatta (gfyoung) in branch 'master':
bpo-29596: Improve clinic howto documentation (GH-1710)
https://github.com/python/cpython/commit/ec19ba210bba2c3097232a05d7dbe093beb5f833
msg295303 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-06-06 21:17
New changeset 063f0b358331322d84f85008e6c01f80ff321fd6 by Mariatta (gfyoung) in branch '3.6':
bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1976)
https://github.com/python/cpython/commit/063f0b358331322d84f85008e6c01f80ff321fd6
msg295305 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-06-06 21:38
New changeset ee9de30aa0dbcfd848e4200944674a084d963588 by Mariatta (gfyoung) in branch '3.5':
bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1975)
https://github.com/python/cpython/commit/ee9de30aa0dbcfd848e4200944674a084d963588
msg295306 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-06-06 21:40
Thanks everyone :)
History
Date User Action Args
2022-04-11 14:58:43adminsetgithub: 73782
2017-06-06 21:40:13Mariattasetstatus: open -> closed
resolution: fixed
messages: + msg295306

stage: patch review -> resolved
2017-06-06 21:38:10Mariattasetmessages: + msg295305
2017-06-06 21:17:20Mariattasetmessages: + msg295303
2017-06-06 20:34:26gfyoungsetpull_requests: + pull_request2042
2017-06-06 20:32:41gfyoungsetpull_requests: + pull_request2041
2017-06-06 19:23:55Mariattasetnosy: + Mariatta
messages: + msg295294
2017-05-30 04:36:43martin.pantersettitle: Unfinished sentense in howto/clinic.rst -> Unfinished sentence in howto/clinic.rst
nosy: + martin.panter

messages: + msg294737

components: + Argument Clinic
stage: needs patch -> patch review
2017-05-22 01:55:40gfyoungsetpull_requests: + pull_request1801
2017-02-24 20:33:42Steven Rumbalskisetnosy: + Steven Rumbalski
messages: + msg288532
2017-02-20 09:27:10xiang.zhangsetnosy: + larry

stage: needs patch
2017-02-18 01:12:12mbussonncreate