Update STYLEGUIDE.md to clarify block usage#449
Merged
Conversation
Removed examples and arguments against multiline chaining with `{...}` in the style guide. This is too much churn for little value. The monolith had >2000 offenses never corrected, and the alternative syntaxes just add more toil.
There was a problem hiding this comment.
Pull request overview
Updates the Ruby style guide’s block delimiter guidance by removing previously included rationale and examples discouraging certain multiline-chaining patterns, aiming to reduce stylistic churn.
Changes:
- Removes the “good/bad” multiline chaining example contrasting
{...}vsdo...end. - Removes the explanatory paragraph arguing against multiline chaining readability concerns.
Show a summary per file
| File | Description |
|---|---|
| STYLEGUIDE.md | Removes examples and narrative text related to multiline chaining/block delimiter preferences. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Low
Comment on lines
+843
to
+846
| * Prefer `{...}` over `do...end` for single-line blocks. Avoid using | ||
| `{...}` for multi-line blocks (multiline chaining is always | ||
| ugly). Always use `do...end` for "control flow" and "method | ||
| definitions" (e.g. in Rakefiles and certain DSLs). Avoid `do...end` | ||
| when chaining. | ||
| definitions" (e.g. in Rakefiles and certain DSLs). |
issyl0
commented
Jun 26, 2026
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.
Removed examples and arguments against multiline chaining with
{...}in the style guide. This is too much churn for little value. The monolith had >2000 offenses never corrected, and the alternative syntaxes just add more toil.