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 indent and numbering in several docs #241

Merged
merged 1 commit into from
Feb 11, 2021

Conversation

kpaulisse
Copy link
Contributor

Overview

This pull request updates numbering and indentation of several docs.

While using these docs I noticed that a lot of the alignment in lists was off, causing the numbering to be undesired:

image

I went through and:

  • Changed the 0. to 1. because otherwise the numeric lists are 0-based.
  • Indented where needed so that the list items are rendered correctly.

I didn't make any changes to content.

All of the updated docs look correct to me when viewed through the GitHub UI on my branch.

Checklist

  • Make sure that all of the tests pass, and fix any that don't. Just run rake in your checkout directory, or review the CI job triggered whenever you push to a pull request.
  • Make sure that there is 100% test coverage by running rake coverage:spec or ignoring untestable sections of code with # :nocov comments. If you need help getting to 100% coverage please ask; however, don't just submit code with no tests.
  • If you have added a new command line option, we would greatly appreciate a corresponding integration test that exercises it from start to finish. This is optional but recommended.
  • If you have added any new gem dependencies, make sure those gems are licensed under the MIT or Apache 2.0 license. We cannot add any dependencies on gems licensed under GPL.
  • If you have added any new gem dependencies, make sure you've checked in a copy of the .gem file into the vendor/cache directory.

@kpaulisse kpaulisse marked this pull request as ready for review February 11, 2021 19:55
Copy link
Contributor

@ahayworth ahayworth left a comment

Choose a reason for hiding this comment

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

🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉
Thanks @kpaulisse!
🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉

@ahayworth ahayworth merged commit 0ba9924 into github:master Feb 11, 2021
@ahayworth ahayworth added this to the 2.1.0 milestone Feb 16, 2021
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.

None yet

3 participants