Use squiggly heredoc for gem description example #352
Closed
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.
Motivation
Using a non-squiggly heredoc adds leading whitespace in the gem description. rubygems.org seems to handle this fine (by relying on HTML ignoring it), but in other contexts it can make it difficult to render the text (e.g. in an editor using an LSP).
I believe the squiggly heredoc is supported on all non-EOL Ruby versions, but I could understand rejecting this change because it might make it impossible to install a gem on EOL versions. Still, felt it was worth opening here.