bpo-19184: Update the documentation of dis module. by mangrisano · Pull Request #13652 · python/cpython (original) (raw)

Thanks for the contribution, @mangrisano! The CI failures are on the lines you added, but I have to research what the error means as I haven't encountered it before.

$ make check suspicious html SPHINXOPTS="-q -W -j4"
python3 tools/rstlint.py -i tools -i ./venv -i README.rst
[2] library/dis.rst:1118: default role used
...

To expand a bit on this: rest uses roles in the form of 📛`value` for inline markup (e.g. :func:`any`). The default role in the message refers to the "unnamed" default role, i.e. `value`, and we don't use that in the Python docs. (Not to be confused with ``value``, used for inline snippets of code).

The devguide talks about roles at https://devguide.python.org/documenting/#id4, but doesn't mention anything about the default role -- perhaps a PR to add an item to that list should be created.