In theory, this is correct (and consistent within the guide I think). It follows the numpydoc docstring guide: https://numpydoc.readthedocs.io/en/latest/format.html

But of course that doesn't mean we need to follow it (how it gets rendered also depends on your sphinx configuration).

In theory, this is correct (and consistent within the guide I think). It follows the numpydoc docstring guide: https://numpydoc.readthedocs.io/en/latest/format.html

Thanks, I wasn't aware of that. They make it quite clear which to use:

Use italics, bold and monospace if needed in any explanations (but not for variable names and doctest code or multi-line code). Variable, module, function, and class names should be written between single back-ticks (numpy).

Pandas' docstrings seem to jump between the two, e.g. isin has both

`values`

and

``values``

So, perhaps this should be changed to encourage easy contributions to be more consistent about this in the docstrings?