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

gemfile.5: Code format the default glob to escape Markdown #6790

Merged
merged 2 commits into from
Jul 5, 2023
Merged

gemfile.5: Code format the default glob to escape Markdown #6790

merged 2 commits into from
Jul 5, 2023

Conversation

ParadoxV5
Copy link
Contributor

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

The default glob as rendered ({,,/*}.gemspec) doesn’t make sense.

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

Quote the default glob in an inline code rather than double-quotes so the *s don’t and will never leak out as Markdown for emphasis.

Make sure the following tasks are checked

  • Describe the problem/feature
  • Write tests for features and bug fixes
  • Write code to solve the problem
  • Make sure you follow the current code style and write meaningful commit messages without tags

For consistency, I chose code format over plaintext escaping.
@welcome
Copy link

welcome bot commented Jul 2, 2023

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

Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@deivid-rodriguez
Copy link
Member

@ParadoxV5 Would you be able to run rake man:build from the branch with your changes and commit the result? Our gemfile.5 file also needs this update, and that's what rake man:build does.

@ParadoxV5
Copy link
Contributor Author

@ParadoxV5 Would you be able to run rake man:build from the branch with your changes and commit the result?

Not quite… I just patched the file on the GitHub web editor 😁. I’ll clone my fork locally rq.

Co-Authored-By: David Rodríguez <2887858+deivid-rodriguez@users.noreply.github.com>
Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @ParadoxV5, thank you!

@deivid-rodriguez deivid-rodriguez merged commit 0837d16 into rubygems:master Jul 5, 2023
92 checks passed
deivid-rodriguez added a commit that referenced this pull request Jul 6, 2023
`gemfile.5`: Code format the default glob to escape Markdown

(cherry picked from commit 0837d16)
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

2 participants