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 tables in README? #169

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Use tables in README? #169

wants to merge 1 commit into from

Conversation

elsiehupp
Copy link

I found the existing README to be somewhat difficult to visually parse, so I tried formatting the commands and return values in tables to make them somewhat clearer.

The two issues I'm stuck on are:

  1. reStructuredText doesn't like that I'm reusing the headline "First:", but it only generates a warning, not an error. This is probably not a breaking issue.
  2. GitHub doesn't seem to respect the inline code-syntax highlighting I used within the table cells. GitHub seemingly only respects block-level code-syntax highlighting, and table cells in neither reStructuredText nor Markdown support blocks.

For problem No. 2, I don't know how the README renders on PyPI, but if PyPI has the same problem it might be worth using more conventional API formatting, like, e.g., the official Python documentation has.

I would be happy to iterate on this pull request if necessary.

Signed-off-by: Elsie Hupp <9206310+elsiehupp@users.noreply.github.com>
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

1 participant