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.

Sign up for GitHub

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

Jump to bottom

Docs Style: quoting paramter names in prose #20879

Closed
TomAugspurger opened this issue Apr 30, 2018 · 3 comments
Closed

Docs Style: quoting paramter names in prose #20879

TomAugspurger opened this issue Apr 30, 2018 · 3 comments
Labels
Code Style Code style, linting, code_checks Docs

Comments

@TomAugspurger
Copy link
Contributor

TomAugspurger commented Apr 30, 2018 •
edited
Loading

Single or double backticks?

We use single for docstrings.

In the HTML rendering, single goes to italics. Double goes to code-formatting.
@TomAugspurger TomAugspurger added Docs Code Style Code style, linting, code_checks labels Apr 30, 2018
@TomAugspurger TomAugspurger added this to the Next Major Release milestone Apr 30, 2018
@WillAyd
Copy link
Member

WillAyd commented Apr 30, 2018

I'm +1 on single backticks - I think the look of italics rendered for these just flows better. Having a lot of code-formatting just for parameter references is distracting

@abi-aryan
Copy link

+1 on single backticks

@TomAugspurger
Copy link
Contributor Author

We can fold this into #19750

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Code Style Code style, linting, code_checks Docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@WillAyd @TomAugspurger @abi-aryan