Add guideline discouraging embedded newlines in puts#977
Open
andyw8 wants to merge 1 commit intorubocop:masterfrom
Open
Add guideline discouraging embedded newlines in puts#977andyw8 wants to merge 1 commit intorubocop:masterfrom
andyw8 wants to merge 1 commit intorubocop:masterfrom
Conversation
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note: PR co-authored with Claude Code
Summary
This PR adds a guideline discouraging the use of embedded newline characters (
\n) inputscalls, in favor of using separateputscalls.Motivation
I've noticed that AI models frequently generate Ruby code using the pattern
puts "\nmessage"when adding blank lines to output. I suspect this is due to training bias from Python codebases, whereprint("\nmessage")is an accepted and common style.However, in Ruby, the idiomatic approach is to use separate
putscalls:This is more readable and aligns better with Ruby conventions.
Next Steps
I was intending to add a new RuboCop cop to enforce this guideline, but I wanted to open this PR here first for discussion. If the community agrees this is a worthwhile guideline, I'll proceed with implementing the corresponding cop in RuboCop.
Changes
putsfor Newlines" in the Misc section