wohali opened a new issue #525: URL: https://github.com/apache/couchdb-documentation/issues/525
This is a Markdown-ism that has crept into our documentation. In Markdown, you can write: ```markdown I can have `preformatted` text by enclosing the text with `single quotes`. ``` Which results in: > I can have `preformatted` text by enclosing the text with `single quotes`. In ReStructuredText, you have to use double backticks to achieve the same result: ```rst I can have ``preformatted`` text by enclosing the text with ``single quotes``. ``` Single ticks are used as escapes in things such as [indirect hyperlink targets](https://github.com/apache/couchdb/pull/2826), and renders as [interpreted text — domain- or application-dependent, which is _not_ what we want](https://docutils.sourceforge.io/docs/user/rst/quickref.html#inline-markup). ## Expected Behavior All preformatted text is correctly enclosed in double backticks, not single. Ideally, our lint checker should scan for this and complain if it finds it, but that may require fancier Python-scripting than desired (no need to implement an entire second parser, right?) ## Files to fix @rnewson pointed this out in #524 as being an issue in `src/api/server/authn.rst`. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
