Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Unfinished sentence in howto/clinic.rst #73782

Closed
Carreau mannequin opened this issue Feb 18, 2017 · 7 comments
Closed

Unfinished sentence in howto/clinic.rst #73782

Carreau mannequin opened this issue Feb 18, 2017 · 7 comments
Labels
3.7 (EOL) end of life docs Documentation in the Doc dir topic-argument-clinic

Comments

@Carreau
Copy link
Mannequin

Carreau mannequin commented Feb 18, 2017

BPO 29596
Nosy @larryhastings, @vadmium, @Carreau, @Mariatta
PRs
  • bpo-29596: Fix missing documentation in clinic.rst #1710
  • bpo-29596: Back-port patch to Python 3.5 #1975
  • bpo-29596: Back-port patch to Python 3.6 #1976
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2017-06-06.21:40:13.830>
created_at = <Date 2017-02-18.01:12:12.615>
labels = ['3.7', 'expert-argument-clinic', 'docs']
title = 'Unfinished sentence in howto/clinic.rst'
updated_at = <Date 2017-06-06.21:40:13.829>
user = 'https://github.com/Carreau'

    bugs.python.org fields:

    activity = <Date 2017-06-06.21:40:13.829>
actor = 'Mariatta'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-06-06.21:40:13.830>
closer = 'Mariatta'
components = ['Documentation', 'Argument Clinic']
creation = <Date 2017-02-18.01:12:12.615>
creator = 'mbussonn'
dependencies = []
files = []
hgrepos = []
issue_num = 29596
keywords = []
message_count = 7.0
messages = ['288048', '288532', '294737', '295294', '295303', '295305', '295306']
nosy_count = 6.0
nosy_names = ['larry', 'docs@python', 'martin.panter', 'mbussonn', 'Mariatta', 'Steven Rumbalski']
pr_nums = ['1710', '1975', '1976']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue29596'
versions = ['Python 3.5', 'Python 3.6', 'Python 3.7']
    @Carreau
    Copy link
    Mannequin Author

    Carreau mannequin commented Feb 18, 2017

    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

    @Carreau Carreau mannequin added the 3.7 (EOL) end of life label Feb 18, 2017
    @Carreau Carreau mannequin assigned docspython Feb 18, 2017
    @Carreau Carreau mannequin added the docs Documentation in the Doc dir label Feb 18, 2017
    @StevenRumbalski
    Copy link
    Mannequin

    StevenRumbalski mannequin commented Feb 24, 2017

    Truncated sentence was always truncated.

    Introduced on commit bebf735
    from Issue bpo-20287: Argument Clinic's output is now configurable, allowing
    delaying its output or even redirecting it to a separate file.
    bebf735

    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'?

    @vadmium
    Copy link
    Member

    vadmium commented May 30, 2017

    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.

    @vadmium vadmium changed the title Unfinished sentense in howto/clinic.rst Unfinished sentence in howto/clinic.rst May 30, 2017
    @Mariatta
    Copy link
    Member

    Mariatta commented Jun 6, 2017

    New changeset ec19ba2 by Mariatta (gfyoung) in branch 'master':
    bpo-29596: Improve clinic howto documentation (GH-1710)
    ec19ba2

    @Mariatta
    Copy link
    Member

    Mariatta commented Jun 6, 2017

    New changeset 063f0b3 by Mariatta (gfyoung) in branch '3.6':
    bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1976)
    063f0b3

    @Mariatta
    Copy link
    Member

    Mariatta commented Jun 6, 2017

    New changeset ee9de30 by Mariatta (gfyoung) in branch '3.5':
    bpo-29596: Improve clinic howto documentation (GH-1710) (GH-1975)
    ee9de30

    @Mariatta
    Copy link
    Member

    Mariatta commented Jun 6, 2017

    Thanks everyone :)

    @Mariatta Mariatta closed this as completed Jun 6, 2017
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    AA-Turner pushed a commit to AA-Turner/devguide that referenced this issue Sep 13, 2023
    @gfyoung @Mariatta
    bpo-29596: Improve clinic howto documentation (GH-1710)
    3fae62e 
    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.

GitHub-Issue-Link: python/cpython#73782
    erlend-aasland pushed a commit to python/devguide that referenced this issue Sep 26, 2023
    @gfyoung @erlend-aasland
    bpo-29596: Improve clinic howto documentation (GH-1710)
    355e339 
    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.

GitHub-Issue-Link: python/cpython#73782
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.7 (EOL) end of life docs Documentation in the Doc dir topic-argument-clinic
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @vadmium @Mariatta