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

[minor] numbered lists in markdown docs #165

Closed
phrawzty opened this issue May 2, 2016 · 3 comments
Closed

[minor] numbered lists in markdown docs #165

phrawzty opened this issue May 2, 2016 · 3 comments

Comments

@phrawzty
Copy link
Collaborator

phrawzty commented May 2, 2016

Right now the README.md has a numbered list which renders properly when viewed in GitHub, but when viewed as text contains a series of non-sequential numbers. This drives me nuts.

Options:

  1. Using just the number 1 over and over, and relying on GitHub to render it properly.
    1. Confusing if it's not rendered properly (or viewed as text).
  2. "Enforcing" manual ordering as a pre-requisite to merging.
    1. Definitely works but is irritating to maintain.
  3. Using bullet lists.
    1. Easy to maintain, consistent behaviour - but it's not numbers.
@mattstratton
Copy link
Member

I vote for option one as it is "correct" Markdown.

@bridgetkromhout
Copy link
Collaborator

I'm addressing this in #175.

@phrawzty
Copy link
Collaborator Author

phrawzty commented May 3, 2016

Alright, so, number one number one number one it is!

@phrawzty phrawzty closed this as completed May 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants