Skip to content

Add the :deco: role #1686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AA-Turner merged 1 commit into from
Nov 10, 2025
Merged

Add the :deco: role #1686

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions documentation/markup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,8 +544,8 @@ The directives are:

Set name of the decorated function to *name*.

There is no ``deco`` role to link to a decorator that is marked up with
this directive; rather, use the ``:func:`` role.
To link to a decorator that is marked up with this directive,
use the ``:deco:`` role.

.. describe:: class

Expand Down Expand Up @@ -806,6 +806,10 @@ a matching identifier is found:

The name of an exception. A dotted name may be used.

.. describe:: deco

The name of a decorator. A dotted name may be used.

The name enclosed in this markup can include a module name and/or a class name.
For example, ``:func:`filter``` could refer to a function named ``filter`` in
the current module, or the built-in function of that name. In contrast,
Expand Down
Loading