◐ Shell
clean mode source ↗

gh-101100: Update .nitignore (after accepting library/test.rst changes) by smontanaro · Pull Request #114770 · python/cpython

No, it shouldn't be linked to. It's an example function, not one we're documenting.

We have several options:

  • ``test_main`` - plain monospace formatting
  • :func:`!test_main` - add an exclamation mark to tell Sphinx to format as a method but not to try and link it

A benefit of the exclamation mark is we get similar formatting to "real" functions, but in this case I don't have a strong preference, as there's also the ``test_`` and ``test_main`` on the same line.