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 heredocs in Gem::Specification#description documentation, so it doesn't add leading whitespace #7373

Merged
merged 1 commit into from Jan 11, 2024

Conversation

bravehager
Copy link
Contributor

What was the end-user or developer problem that led to this PR?

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).

(also see rubygems/guides#352)

What is your fix for the problem, implemented in this PR?

Use a squiggly heredoc in the specification documentation.

Make sure the following tasks are checked

Copy link

welcome bot commented Jan 10, 2024

Thanks for opening a pull request and helping make RubyGems and Bundler better! Someone from the RubyGems team will take a look at your pull request shortly and leave any feedback. Please make sure that your pull request has tests for any changes or added functionality.

We use GitHub Actions to test and make sure your change works functionally and uses acceptable conventions, you can review the current progress of GitHub Actions in the PR status window below.

If you have any questions or concerns that you wish to ask, feel free to leave a comment in this PR or join our #rubygems or #bundler channel on Slack.

For more information about contributing to the RubyGems project feel free to review our CONTRIBUTING guide

@hsbt hsbt enabled auto-merge January 10, 2024 23:47
@hsbt hsbt merged commit 4fee515 into rubygems:master Jan 11, 2024
74 checks passed
@deivid-rodriguez deivid-rodriguez changed the title Update documentation to use squiggly heredoc Use squiggly heredocs in Gem::Specification#description documentation, so it doesn't add leading whitespace Jan 15, 2024
deivid-rodriguez pushed a commit that referenced this pull request Jan 17, 2024
Update documentation to use squiggly heredoc

(cherry picked from commit 4fee515)
deivid-rodriguez pushed a commit that referenced this pull request Jan 17, 2024
Update documentation to use squiggly heredoc

(cherry picked from commit 4fee515)
deivid-rodriguez pushed a commit that referenced this pull request Jan 17, 2024
Update documentation to use squiggly heredoc

(cherry picked from commit 4fee515)
deivid-rodriguez pushed a commit that referenced this pull request Jan 17, 2024
Update documentation to use squiggly heredoc

(cherry picked from commit 4fee515)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants