Skip to content

docs: Add link name to decorator api #105

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
maximilianruesch merged 1 commit into from
Apr 20, 2026
Merged

docs: Add link name to decorator api #105

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
5 changes: 4 additions & 1 deletion sphinx/api/decorator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
```{eval-rst}
.. currentmodule:: guppylang.decorator

.. decorator:: guppy (*, unitary=False, control=False, dagger=False, power=False, max_qubits=None)
.. decorator:: guppy (*, unitary=False, control=False, dagger=False, power=False, max_qubits=None, link_name=None)

Registers a function for Guppy compilation. This is the main decorator that applies to most use cases / functions
written in Guppy.
Expand All @@ -20,6 +20,9 @@
:keyword max_qubits: Hints the maximum number of qubits that this function uses. When used on the entrypoint function,
allows to omit the `n_qubits` parameter when calling :func:`~guppylang.defs.GuppyFunctionDefinition.emulator`.
:type max_qubits: python:int | None
:keyword link_name: Override the name the function will receive when compiled into a HUGR package. The default
name is based on the fully module-qualified name of the function.
:type link_name: python:str | None
:rtype: GuppyFunctionDefinition

.. code-block:: python
Expand Down
Loading