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

Fix formatting in docs #5470

Merged
merged 1 commit into from Apr 14, 2022
Merged

Conversation

peterzhu2118
Copy link
Contributor

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

rdoc uses + for typewriter font rather than backticks. This causes incorrect formatting in the generated docs.

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

Use + instead of backticks.

Make sure the following tasks are checked

@welcome
Copy link

welcome bot commented Apr 13, 2022

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

rdoc uses + for typewriter font rather than backticks.
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, will try to remember this in the future, since I guess there's no easy way to automatically enforce this? Maybe a RuboCop cop, NoBackticksInDocumentationHeader or something could help.

@peterzhu2118
Copy link
Contributor Author

Unfortunately I don't know of a way to detect this automatically (using either rubocop or rdoc).

@deivid-rodriguez deivid-rodriguez merged commit 9f5c69d into rubygems:master Apr 14, 2022
deivid-rodriguez added a commit that referenced this pull request Apr 20, 2022
Fix formatting in docs

(cherry picked from commit 9f5c69d)
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