Skip to content

Text copy-edit in the tutorial? Passing a dict named 'table' #93240

Closed
Closed
Text copy-edit in the tutorial? Passing a dict named 'table'#93240
Labels
3.10 (EOL)end of life3.11only security fixes3.12only security fixesdocsDocumentation in the Doc dir

Description

@JoshuaPollinger
JoshuaPollinger
opened on May 26, 2022

Documentation

https://docs.python.org/3.12/tutorial/inputoutput.html#the-string-format-method

Hi everyone! I'm reading through the tutorial and at section "7.1.2. The String format() Method", the sixth paragraph refers to passing a dictionary (named "table") as an argument. Here's the text as it reads:

This could also be done by passing the table as keyword arguments with the '**' notation.

But I think it would be more clear if the text was written as follows:

This could also be done by passing the dict as keyword arguments with the '**' notation.

or

This could also be done by passing the dict (in this example 'table') as keyword arguments with the '**' notation.

Hope this feedback is helpful! thanks!!

Activity

  1. JoshuaPollinger
    added
    docsDocumentation in the Doc dir
    on May 26, 2022

  2. AA-Turner commented on May 26, 2022

    @AA-Turner
    AA-Turner
    on May 26, 2022
    Member

    A pull request would be welcomed.

    A

  3. AA-Turner
    added
    3.11only security fixes
    3.10 (EOL)end of life
    3.12only security fixes
    on May 26, 2022

  4. AA-Turner commented on May 26, 2022

    @AA-Turner
    AA-Turner
    on May 26, 2022
    Member

    (I'd probably go for This could also be done by passing the ``table`` dictionary as keyword arguments with the ``**`` notation.).

  5. paulreece commented on May 27, 2022

    @paulreece
    paulreece
    on May 27, 2022
    Contributor

    Hi I made the adjustment and created a PR here #93276

  6. ambv
    added a commit that references this issue on Jun 21, 2022

    gh-93240: clarify wording in IO tutorial (GH-93276)

    51d6731
  7. miss-islington
    added a commit that references this issue on Jun 21, 2022

    pythongh-93240: clarify wording in IO tutorial (pythonGH-93276)

    e3f0352
  8. ambv
    added 3 commits that reference this issue on Jun 21, 2022

    [3.11] pythongh-93240: clarify wording in IO tutorial (pythonGH-93276)

    65b435c

    [3.11] gh-93240: clarify wording in IO tutorial (GH-93276) (GH-94082)

    c76e6f7

    gh-93240: clarify wording in IO tutorial (GH-93276) (GH-94081)

    6432a89

  9. ambv commented on Jun 21, 2022

    @ambv
    ambv
    on Jun 21, 2022
    Contributor

    Fixed. Thanks! ✨ 🍰 ✨

  10. ambv
    closed this as completedon Jun 21, 2022
  11. serhiy-storchaka
    added a commit that references this issue on Jun 26, 2022

    Revert 30935 defer bpo45162 to 312 (#94285)

    1ffde3e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.10 (EOL)end of life3.11only security fixes3.12only security fixesdocsDocumentation in the Doc dir

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions