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

DOC - General formatting suggestion #33

Closed
blthayer opened this issue Feb 5, 2022 · 0 comments · Fixed by #37
Closed

DOC - General formatting suggestion #33

blthayer opened this issue Feb 5, 2022 · 0 comments · Fixed by #37

Comments

@blthayer
Copy link

blthayer commented Feb 5, 2022

(100% optional) - In the documentation, italics is often used, e.g.:

... then open your .sam case file.

and

can_fail can be set to true or false...

It's easier to read if fixed width formatting (single back-ticks in Markdown, double back-ticks in ReStructuredText) is used, e.g.:

  • ... then open you .sam case file
  • can_fail can be set to true or false
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 a pull request may close this issue.

1 participant