search

rubygems / guides

An effort to provide awesome documentation for the RubyGems ecosystem.
https://guides.rubygems.org
Other
153 stars 189 forks source link

Use squiggly heredoc for gem description example #352

Closed bravehager closed 10 months ago

bravehager commented 10 months ago

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 commented 10 months ago

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 commented 10 months ago

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 https://github.com/rubygems/rubygems/pull/7373, let me know if I should close this one out.

deivid-rodriguez commented 10 months ago

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