Skip to content

docs: fix incorrect API docstrings #295

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
mstechly merged 2 commits into from
Jun 5, 2026
Merged

docs: fix incorrect API docstrings #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d942dd8
docs: fix incorrect API docstrings
tcNickolas Jun 5, 2026
4df7a98
chore: address flake fail
tcNickolas Jun 5, 2026
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
4 changes: 3 additions & 1 deletion src/bartiq/integrations/latex.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ def routine_to_latex(

Args:
routine: The routine to render.
show_non_root_costs: If ``True`` (default), displays all costs, otherwise only includes costs
show_non_root_resources: If ``True`` (default), displays all costs, otherwise only includes costs
from the root node.
paged: If ``True``, returns the resources as a list of strings, otherwise concatenates them
into a single string. Defaults to ``False``.

Returns:
A LaTeX snippet of the routine.
Expand Down
9 changes: 5 additions & 4 deletions src/bartiq/transform.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,16 +101,17 @@ def add_aggregated_resources(
Args:
routine: The program to which the resources will be added.
aggregation_dict: A dictionary that decomposes resources into more fundamental components along with their
respective multipliers. The multipliers can be numeric values or strings representing valid bartiq expressions.
respective multipliers. The multipliers can be numeric values or strings representing valid bartiq
expressions.
Example:
{
"swap": {"CNOT": 3},
"arbitrary_z": {"T_gates": "3*log2(1/epsilon) + O(log(log(1/epsilon)))"},
...
}
remove_decomposed : Whether to remove the decomposed resources from the routine.
remove_decomposed: Whether to remove the decomposed resources from the routine.
Defaults to True.
backend : Backend instance to use for handling expressions.
backend: Backend instance to use for handling expressions.
Defaults to `sympy_backend`.

Returns:
Expand Down Expand Up @@ -255,7 +256,7 @@ def add_circuit_volume(
routine: The compiled routine to which the resource will be added.
name_of_aggregated_t: Name of the resource representing the number of T gates (default: 'aggregated_t_gates').
name_of_qubit_highwater: Name of the resource representing the qubit highwater mark
(default: 'qubit_highwater').
(default: 'qubit_highwater').
backend: Symbolic backend to use for symbolic operations.

Returns:
Expand Down
Loading