docstring modif in nw.spot, regenerate api accordingly

qnngroup · May 14, 2024 · 98004b9 · 98004b9
1 parent e12264a
commit 98004b9
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/docs/user/api.rst b/docs/user/api.rst
@@ -7,7 +7,7 @@ Cells
 
 .. automodule:: qnngds.cells
     :members:
-    :exclude-members: alignment, etch_test, nanowires, ntron, resolution_test, snspd, vdp
+    :exclude-members: alignment, etch_test, nanowires, ntron, resolution_test, snspd, snspd_ntron, vdp
     :undoc-members:
     :show-inheritance:
 
@@ -41,6 +41,11 @@ Cells
         .. image:: images/cells/snspd.png
             :alt: snspd.png
 
+    .. autofunction:: snspd_ntron
+
+        .. image:: images/cells/snspd_ntron.png
+            :alt: snspd_ntron.png
+
     .. autofunction:: vdp
 
         .. image:: images/cells/vdp.png
@@ -52,10 +57,15 @@ Circuits
 
 .. automodule:: qnngds.circuits
     :members:
-    :exclude-members: 
+    :exclude-members: snspd_ntron
     :undoc-members:
     :show-inheritance:
 
+    .. autofunction:: snspd_ntron
+
+        .. image:: images/circuits/snspd_ntron.png
+            :alt: snspd_ntron.png
+
 .. _Design:
 Design
 ------

diff --git a/src/qnngds/devices/nanowire.py b/src/qnngds/devices/nanowire.py
@@ -13,8 +13,8 @@ def spot(
     layer: int = dflt.layers["device"],
     num_pts: int = 100,
 ) -> Device:
-    """Creates a single wire, with the same appearance as an NTRON but without
-    the gate.
+    """Creates a single wire, made of two optimal steps from channel_w to
+    source_w.
 
     Args:
         channel_w (int or float): The width of the channel (at the hot-spot location).