DOC: Update a few interpreted text to verbatim/code. #25501
Conversation
Single backticks are meant to reference another object and sphinx/docutils is trying to fond those. In the current sphinx theme those are rendered in italic. For all those I assume what was meant is actually code, or verbatim.
There was a problem hiding this comment.
These all look correct to me and CI failure appears unrelated. Commit history looks good so I'll regular-merge.
@Carreau what do you think of my suggestions to clarify this in the numpydoc style guide?
numpy/numpydoc@main...mdhaber:numpydoc:backticks
This is part of a larger plan to render references to parameters in monospaced font and eventually as links to the parameter descriptions.
|
Related to #13114. This brings the number of warnings down to 105. Thanks @Carreau |
Yeah, I think it is good to clarify, but I don't think the problem is clarification, the problem is single and double backticks are too easy to confuse, especially with markdown. Funny thing, is I also sent thin because I'm working on having reference to parameter rendering differently but not for sphinx. IMHO a think that would help – nut I'm not sure how to do. Is to have a different style that is potentially quite visible for all sphinx references that have not been resolved. This way it's easy at a glance to a page to tell if there are issues. |
Single backticks are meant to reference another object and sphinx/docutils is trying to fond those.
In the current sphinx theme those are rendered in italic.
For all those I assume what was meant is actually code, or verbatim.