question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Document when to use single backticks

See original GitHub issue

Related to https://github.com/scikit-learn/scikit-learn/pull/13542, https://github.com/scikit-learn/scikit-learn/pull/13542

Currently our single backticks will resolve as follows: python->glossary->code. We should document when we recommend to use single backticks.

@NicolasHug mentioned in https://github.com/scikit-learn/scikit-learn/pull/14381#pullrequestreview-275449342

I’d also still recommend double backticks by default and only use single backticks when we are certain want to generate links.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:9 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
NicolasHugcommented, Aug 15, 2019

Thanks for opening the issue.

I’ll copy my https://github.com/scikit-learn/scikit-learn/pull/14381#issuecomment-521676762

(About using single backticks by default): As previously said, this is risky. That will link to things that should not be linked, you and I experienced it in the visualizer PR and plot.

I’d rather risk having no link than having a bad link. A link shows intent. It means “look here, you’ll find useful information”. Landing to a bad page will only add confusion to readers.

I really don’t understand why we want to go against the rst spec here. Yes, the rst standard can be a huge pain sometimes, but patching it seems like a bad idea to me.

0reactions
thomasjpfancommented, Aug 20, 2019

Don’t have a strong opinion. so :py: does the linking to code and modules?

I mistyped. We still need :class:, :term:, :mod:, etc. (The default domain is :py:.)

Read more comments on GitHub >

github_iconTop Results From Across the Web

When to use single quotes, double quotes, and backticks in ...
Back-ticks are never used in standard SQL. (If you need to include a double quote in an identifier, type it twice as "odd""tablename"...
Read more >
Single Quote, Double Quote, and Backticks in MySQL Queries
Backticks are used around table and column identifiers. Double Quotes. Using double quotes here is some input and output examples: SELECT " ...
Read more >
Any reference on the usage of a backtick and single quotation ...
1. backtick (aks grave accent) ``` ` ``` 2. (real) single quote mark (apostrophe) `'` 3. left single quotes `'` 4. right single...
Read more >
“Double Quotes” vs 'Single Quotes' vs `Backticks` in JavaScript
Although single quotes and double quotes are the most popular, we have a 3rd option called Backticks ( `` ). Backticks are an...
Read more >
Is there a difference between backticks and single quotes?
A single-quote is essentially deparsed as a double-quote. A backtick is used to refer to inherent symbols or illegal symbols in r.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found