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

format: add code backticks and "mention" to Quickstart #119

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

Conversation

agilgur5
Copy link

@agilgur5 agilgur5 commented Jul 5, 2023

Summary

Tiny formatting improvements to the Quickstart Guide

Details

  • pip and @metric were missing code backticks
  • bottom links all used the title as the name but didn't use the fancy "mention" syntax

Future Work(?)

There's lots of places in the docs that don't use the "mention" syntax. In some cases, that's because they have different link text (like elsewhere in this guide), but in others it's not clear why they don't use that syntax.

- `pip` and `@metric` were missing code backticks
- bottom links all used the title as the name but didn't use the fancy "mention" syntax
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.

1 participant