From 654a547bd547235c097e0355c7c82be5711435d7 Mon Sep 17 00:00:00 2001 From: Sedat Date: Mon, 23 Mar 2026 22:21:01 +1100 Subject: [PATCH] docs: fix incorrect :py:class: role for method reference Closes #186 PluginManager.add_hookcall_monitoring() is a method, not a class. Replace the incorrect :py:class: role with :py:meth: so that Sphinx generates the correct cross-reference link. --- changelog/186.doc.rst | 3 +++ docs/index.rst | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 changelog/186.doc.rst diff --git a/changelog/186.doc.rst b/changelog/186.doc.rst new file mode 100644 index 00000000..407e8770 --- /dev/null +++ b/changelog/186.doc.rst @@ -0,0 +1,3 @@ +Fix incorrect ``:py:class:`` role used for a method reference in +``docs/index.rst``; ``PluginManager.add_hookcall_monitoring()`` is +now correctly referenced with ``:py:meth:``. diff --git a/docs/index.rst b/docs/index.rst index b98c4956..788d4362 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -996,7 +996,7 @@ Call monitoring --------------- Instead of using the built-in tracing mechanism you can also add your own ``before`` and ``after`` monitoring functions using -:py:class:`pluggy.PluginManager.add_hookcall_monitoring()`. +:py:meth:`pluggy.PluginManager.add_hookcall_monitoring()`. The expected signature and default implementations for these functions is: