Skip to content

Add guideline discouraging embedded newlines in puts #977

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

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

Add guideline discouraging embedded newlines in puts #977

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
15 changes: 15 additions & 0 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5893,6 +5893,21 @@ $stderr.puts 'This is a warning!'
warn 'This is a warning!'
----

=== Separate `puts` for Newlines [[puts-newlines]]

Use separate `puts` calls instead of embedding newline characters (`\n`) in strings.
This improves readability and follows Ruby conventions.

[source,ruby]
----
# bad
puts "\nmessage"

# good
puts
puts 'message'
----

=== `Array#join` [[array-join]]

Prefer the use of `Array#join` over the fairly cryptic `Array#*` with a string argument.
Expand Down