Skip to content

Commit 982e4be

Browse files
committed
DOC: Add docstring for bond_kwargs in show()
1 parent 2e2bd32 commit 982e4be

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

tensorcircuit/templates/lattice.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,10 @@ def show(
300300
:param ax: An existing Matplotlib Axes object to plot on.
301301
If None, a new Figure and Axes are created automatically. Defaults to None.
302302
:type ax: Optional["matplotlib.axes.Axes"], optional
303+
:param bond_kwargs: A dictionary of keyword arguments for customizing bond appearance,
304+
passed directly to the Matplotlib plot function. Defaults to None.
305+
:type bond_kwargs: Optional[Dict[str, Any]], optional
306+
303307
:param kwargs: Additional keyword arguments to be passed directly to the
304308
`matplotlib.pyplot.scatter` function for customizing site appearance.
305309
"""

0 commit comments

Comments
 (0)