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.

change double backtick to single backtick do take advantage of default role?

See original GitHub issue

Should we change the double backticks to single backticks in the docs to make use of the new default role (#11186). That way we get more links to the glossary. Do we want to link to the glossary at every mention of fit?

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:13 (13 by maintainers)

github_iconTop GitHub Comments

1reaction
jorisvandenbosschecommented, Jan 4, 2019

I think we should be able to suppress those warnings in doc/conf.py, at least that’s what I’m doing in #12654 for some matplotlib warnings.

That’s an actual matplotlib ‘python’ warning, while here we are speaking about sphinx ‘log’ warnings. So I don’t think it can be done in the same way?

Perhaps http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-suppress_warnings or maybe it’s too general

I didn’t try, but it seems to general. Because we would only want to suppress warnings if it came from this default :any: role, we still want to see warnings if we made a type in an explicit :ref:.. or :term:.. ?

Personally, I would only use single backticks if we explicitly want it to link to something (and using single backticks instead of the actual :role:`..` to make it shorter, more readable in plain text, …), and still use double backticks if we know that the content won’t references anything and simply want to render it as code.

0reactions
amuellercommented, Jul 14, 2019

apart from breaking all PRs 😉

Read more comments on GitHub >

github_iconTop Results From Across the Web

“Double Quotes” vs 'Single Quotes' vs `Backticks` in JavaScript
The same theory applies to double quotes, and you have to use a backslash to escape any double quotes inside double quotes.
Read more >
Why do Unix man pages use double backticks in place of ...
followed by double single quotes '' to wrap quoted phrases instead of the double quote character " . Single quotes are similarly replaced....
Read more >
VSCode single or double quote to backticks automatice replace
I want that every time I click save, the formatter will change all my quotes type to backticks. I tried the built-in VSCode...
Read more >
quotes - ESLint - Pluggable JavaScript Linter
Options · "double" (default) requires the use of double quotes wherever possible · "single" requires the use of single quotes wherever possible ·...
Read more >
Why does ` (backtick) not appear until after I press another key?
If you have more than one keyboard layout installed, on Windows you can use Ctrl + Shift to switch between them. Share.
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