Skip to content

Commit e614f4f

Browse files
committed
Revise wording on state visualization filename arg
1 parent 3b8e1c5 commit e614f4f

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

qiskit/visualization/state_visualization.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def plot_state_hinton(state, title="", figsize=None, ax_real=None, ax_imag=None,
4848
title (str): a string that represents the plot title
4949
figsize (tuple): Figure size in inches.
5050
filename (str | None): The optional file path to save image to. If not specified
51-
no file is created for the visualization. If this is not ``None`` the return
51+
no file is created for the visualization. If this is set the return
5252
from this function will be ``None``.
5353
ax_real (matplotlib.axes.Axes): An optional Axes object to be used for
5454
the visualization output. If none is specified a new matplotlib
@@ -284,7 +284,7 @@ def plot_bloch_multivector(
284284
title_pad (float): Padding for the title (suptitle ``y`` position is ``0.98``
285285
and the image height will be extended by ``1 + title_pad/100``).
286286
filename (str | None): The optional file path to save image to. If not specified
287-
no file is created for the visualization. If this is not ``None`` the return
287+
no file is created for the visualization. If this is set the return
288288
from this function will be ``None``.
289289
290290
Returns:
@@ -409,7 +409,7 @@ def plot_state_city(
409409
Additionally, if specified there will be no returned Figure since
410410
it is redundant.
411411
filename (str | None): The optional file path to save image to. If not specified
412-
no file is created for the visualization. If this is not ``None`` the return
412+
no file is created for the visualization. If this is set the return
413413
from this function will be ``None``.
414414
415415
Returns:
@@ -651,7 +651,7 @@ def plot_state_paulivec(state, title="", figsize=None, color=None, ax=None, *, f
651651
Figure will be created and used. Additionally, if specified there
652652
will be no returned Figure since it is redundant.
653653
filename (str | None): The optional file path to save image to. If not specified
654-
no file is created for the visualization. If this is not ``None`` the return
654+
no file is created for the visualization. If this is set the return
655655
from this function will be ``None``.
656656
657657
Returns:
@@ -838,7 +838,7 @@ def plot_state_qsphere(
838838
use_degrees (bool): An optional boolean indicating whether to use
839839
radians or degrees for the phase values in the plot.
840840
filename (str | None): The optional file path to save image to. If not specified
841-
no file is created for the visualization. If this is not ``None`` the return
841+
no file is created for the visualization. If this is set the return
842842
from this function will be ``None``.
843843
844844

0 commit comments

Comments
 (0)