Skip to content

Commit 5c814ea

Browse files
committed
fixing default args docs in 'plotting'
1 parent ec147de commit 5c814ea

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

docs/plotting.html

+12-15
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,9 @@ <h1 class="title">Module <code>quera_ahs_utils.plotting</code></h1>
5353

5454
Args:
5555
register (AtomArrangement): A given register
56-
blockade_radius (float): The blockade radius for the register. Default is 0
57-
what_to_draw (str): Either &#34;bond&#34; or &#34;circle&#34; to indicate the blockade region.
58-
Default is &#34;bond&#34;
59-
show_atom_index (bool): Whether showing the indices of the atoms. Default is True
56+
blockade_radius (float): Default is 0. The blockade radius for the register.
57+
what_to_draw (str): Default is &#34;bond&#34;. Either &#34;bond&#34; or &#34;circle&#34; to indicate the blockade region.
58+
show_atom_index (bool): Default is True. Whether showing the indices of the atoms.
6059

6160
&#34;&#34;&#34;
6261
filled_sites = [site.coordinate for site in register if site.site_type == SiteType.FILLED]
@@ -91,7 +90,7 @@ <h1 class="title">Module <code>quera_ahs_utils.plotting</code></h1>
9190
&#34;&#34;&#34;Plot the driving field
9291
Args:
9392
drive (DrivingField): The driving field to be plot
94-
axes: matplotlib axis to draw on
93+
axes: Default is None. matplotlib axis to draw on
9594
**plot_ops: options passed to matplitlib.pyplot.plot
9695
&#34;&#34;&#34;
9796

@@ -502,7 +501,7 @@ <h2 id="args">Args</h2>
502501
<dt><strong><code>drive</code></strong> :&ensp;<code>DrivingField</code></dt>
503502
<dd>The driving field to be plot</dd>
504503
<dt><strong><code>axes</code></strong></dt>
505-
<dd>matplotlib axis to draw on</dd>
504+
<dd>Default is None. matplotlib axis to draw on</dd>
506505
<dt><strong><code>**plot_ops</code></strong></dt>
507506
<dd>options passed to matplitlib.pyplot.plot</dd>
508507
</dl></div>
@@ -514,7 +513,7 @@ <h2 id="args">Args</h2>
514513
&#34;&#34;&#34;Plot the driving field
515514
Args:
516515
drive (DrivingField): The driving field to be plot
517-
axes: matplotlib axis to draw on
516+
axes: Default is None. matplotlib axis to draw on
518517
**plot_ops: options passed to matplitlib.pyplot.plot
519518
&#34;&#34;&#34;
520519

@@ -580,12 +579,11 @@ <h2 id="args">Args</h2>
580579
<dt><strong><code>register</code></strong> :&ensp;<code>AtomArrangement</code></dt>
581580
<dd>A given register</dd>
582581
<dt><strong><code>blockade_radius</code></strong> :&ensp;<code>float</code></dt>
583-
<dd>The blockade radius for the register. Default is 0</dd>
582+
<dd>Default is 0. The blockade radius for the register.</dd>
584583
<dt><strong><code>what_to_draw</code></strong> :&ensp;<code>str</code></dt>
585-
<dd>Either "bond" or "circle" to indicate the blockade region.
586-
Default is "bond"</dd>
584+
<dd>Default is "bond". Either "bond" or "circle" to indicate the blockade region. </dd>
587585
<dt><strong><code>show_atom_index</code></strong> :&ensp;<code>bool</code></dt>
588-
<dd>Whether showing the indices of the atoms. Default is True</dd>
586+
<dd>Default is True. Whether showing the indices of the atoms.</dd>
589587
</dl></div>
590588
<details class="source">
591589
<summary>
@@ -601,10 +599,9 @@ <h2 id="args">Args</h2>
601599

602600
Args:
603601
register (AtomArrangement): A given register
604-
blockade_radius (float): The blockade radius for the register. Default is 0
605-
what_to_draw (str): Either &#34;bond&#34; or &#34;circle&#34; to indicate the blockade region.
606-
Default is &#34;bond&#34;
607-
show_atom_index (bool): Whether showing the indices of the atoms. Default is True
602+
blockade_radius (float): Default is 0. The blockade radius for the register.
603+
what_to_draw (str): Default is &#34;bond&#34;. Either &#34;bond&#34; or &#34;circle&#34; to indicate the blockade region.
604+
show_atom_index (bool): Default is True. Whether showing the indices of the atoms.
608605

609606
&#34;&#34;&#34;
610607
filled_sites = [site.coordinate for site in register if site.site_type == SiteType.FILLED]

0 commit comments

Comments
 (0)