Skip to content

bpo-34524: Update comments for examples of format conversion #8964

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

Closed
rarevans wants to merge 1 commit into from
Closed

bpo-34524: Update comments for examples of format conversion #8964

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Doc/library/string.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,9 +259,9 @@ on the value, ``'!r'`` which calls :func:`repr` and ``'!a'`` which calls

Some examples::

"Harold's a clever {0!s}" # Calls str() on the argument first
"Bring out the holy {name!r}" # Calls repr() on the argument first
"More {!a}" # Calls ascii() on the argument first
"Harold's a clever {0!s}" # Calls str() on the first argument
"Bring out the holy {name!r}" # Calls repr() on a named argument
"More {!a}" # Calls ascii() on an implicit argument

@ericvsmith ericvsmith Aug 28, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The examples say "on the argument first", because it's trying to say that !a, !s, and !r are conversions that are called first. That is, they're called before the resulting string is formatted.

I agree that the comments aren't great, but I think any changes need to make this point about conversions being applied first, and your edits lose that. Maybe something like "Calls str() on the argument before formatting the resulting string"? I realize it's a little long.

@rarevans rarevans Aug 28, 2018

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay Eric, that is not how I read it when I encountered it. I can see what you mean about the original. This change is unnecessary then.


The *format_spec* field contains a specification of how the value should be
presented, including such details as field width, alignment, padding, decimal
Expand Down