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.

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

Use squiggly heredoc for gem description example #352

Closed
wants to merge 1 commit into from

Conversation

bravehager
Copy link

@bravehager bravehager commented Jan 9, 2024

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.

@deivid-rodriguez
Copy link
Member

This should be patched here: https://github.com/rubygems/rubygems/blob/8ffa73df3a250623b13c5bf7ab48ed8b8e84e46f/lib/rubygems/specification.rb#L304, since that's the source of truth for this documentation.

@bravehager
Copy link
Author

This should be patched here: https://github.com/rubygems/rubygems/blob/8ffa73df3a250623b13c5bf7ab48ed8b8e84e46f/lib/rubygems/specification.rb#L304, since that's the source of truth for this documentation.

Opened rubygems/rubygems#7373, let me know if I should close this one out.

@deivid-rodriguez
Copy link
Member

Thanks! Yes, this one should be closed and the documentation will be automatically updated once the rubygems change is released (next week).

@bravehager bravehager closed this Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants