Skip to content
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

documentation: Improve docstring for make_bound_circuit #784

Merged
merged 2 commits into from
Nov 6, 2023
Merged

documentation: Improve docstring for make_bound_circuit #784

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bdd3465
documentation: Improve docstring for make_bound_circuit
laurencap Nov 6, 2023
9744782
Merge branch 'main' into fixup/make-bound-circuit-docstring
laurencap Nov 6, 2023
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: 4 additions & 4 deletions src/braket/circuits/circuit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -855,8 +855,8 @@ def make_bound_circuit(self, param_values: dict[str, Number], strict: bool = Fal
Args:
param_values (dict[str, Number]): A mapping of FreeParameter names
to a value to assign to them.
strict (bool): If True, raises a ValueError if none of the FreeParameters
in param_values appear in the circuit. False by default."
strict (bool): If True, raises a ValueError if any of the FreeParameters
in param_values do not appear in the circuit. False by default.

Returns:
Circuit: Returns a circuit with all present parameters fixed to their respective
Expand All @@ -875,8 +875,8 @@ def _validate_parameters(self, parameter_values: dict[str, Number]) -> None:
to a value to assign to them.

Raises:
ValueError: If there are no parameters that match the key for the arg
param_values.
ValueError: If a parameter name is given which does not appear in the circuit.

"""
parameter_strings = set()
for parameter in self.parameters:
Expand Down