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

Change the suggested format token style #913

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Change the suggested format token style #913

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4862,28 +4862,34 @@ sprintf('%d %d', 20, 10)
# => '20 10'

# good
sprintf('%<first>d %<second>d', first: 20, second: 10)
sprintf('%{first} %{second}', first: 20, second: 10)
# => '20 10'

format('%d %d', 20, 10)
# => '20 10'

# good
format('%<first>d %<second>d', first: 20, second: 10)
format('%{first} %{second}', first: 20, second: 10)
# => '20 10'
----

=== Named Format Tokens [[named-format-tokens]]

When using named format string tokens, favor `%<name>s` over `%{name}` because it encodes information about the type of the value.
When using named format string tokens, favor `%{name}` over `%<name>s` or `%<name>`.
An exception is when formatting, as the `%<name>s` style uses format style, but `%{name}` style doesn't.

[source,ruby]
----
# bad
format('Hello, %{name}', name: 'John')
format('Total: %<sum>d', sum: 123.567)
format('Hello, %<name>', name: 'John')

# ok - using format style
format('Total: %<sum>7.2f', sum: 123.456) # => ' 123.68'

# good
format('Hello, %<name>s', name: 'John')
format('Total: %{sum}d', sum: 123.567)
format('Hello, %{name}', name: 'John')
----

=== Long Strings [[heredoc-long-strings]]
Expand Down