Skip to content

Commit

Permalink
documentation: Improve docstring for make_bound_circuit (#784)
Browse files Browse the repository at this point in the history
  • Loading branch information
laurencap authored Nov 6, 2023
1 parent 9dfb98c commit 8dd8c7d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/braket/circuits/circuit.py
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

0 comments on commit 8dd8c7d

Please sign in to comment.