still adding more docs, fixed issues

flexcompute · Jan 3, 2025 · f8b0af9 · f8b0af9
1 parent bed7967
commit f8b0af9
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/tidy3d/components/material/tcad/charge.py b/tidy3d/components/material/tcad/charge.py
@@ -133,7 +133,7 @@ class SemiconductorMedium(AbstractChargeMedium):
                C = N_d - N_a
            \\end{equation}
 
-    Let's explore how these material properties are defined as class parameters or other classes.
+        Let's explore how these material properties are defined as class parameters or other classes.
 
          .. list-table::
            :widths: 25 25 75

diff --git a/tidy3d/components/tcad/doping.py b/tidy3d/components/tcad/doping.py
@@ -84,10 +84,10 @@ class GaussianDoping(AbstractDopingBox):
     -----
     The Gaussian doping concentration :math:`N` is defined in relation to a reference
     concentration :math:`\\{N_{\\text{ref}}` as ``ref_con``,
-    maximum target concentration :math:`\\{N_{\\text{ref}}` as ``concentration``, a Gaussian :parameter:`width`,
-    and a doping box :parameter`size`.
+    maximum target concentration :math:`\\{N_{\\text{ref}}` as ``concentration``, a Gaussian ``width``,
+    and a doping box ``size``.
 
-    TODO can we do better parameter names here more related to the equations?
+    TODO can we do better parameter names here more related to the equations? TODO how does the size get defined.
 
     .. math::
 

diff --git a/tidy3d/components/tcad/generation_recombination.py b/tidy3d/components/tcad/generation_recombination.py
@@ -36,12 +36,12 @@ class ShockleyReedHallRecombination(Tidy3dBaseModel):
 
         .. math::
 
-            R_{SRH} = \\frac{n p - n_0 p_0}{\\tau_p \\left(n + \\sqrt{n_0 p_0}\\right) + \\tau_n \\left(p + \\sqrt{n_0 p_0}\\right)}.
-
+           R_{SRH} = \\frac{n p - n_0 p_0}{\\tau_p \\left(n + \\sqrt{n_0 p_0}\\right) + \\tau_n \\left(p + \\sqrt{n_0 p_0}\\right)}.
 
         Note that the electron and holes densities are defined within the :class:`SemiconductorMedium`. The electron
         lifetime :math:`\\tau_n` and hole lifetimes :math:`\\tau_p` need to be defined.
 
+
         .. [1] Schenk. A model for the field and temperature dependence of shockley-read-hall
                lifetimes in silicon. Solid-State Electronics, 35:1585–1596, 1992.
 

diff --git a/tidy3d/components/tcad/mobility.py b/tidy3d/components/tcad/mobility.py
@@ -18,7 +18,7 @@ class CaugheyThomasMobility(Tidy3dBaseModel):
     -------
     There are some current limitations of this model:
 
-    - high electric field effects not yet supported.
+    - High electric field effects not yet supported.
     - Default values are those appropriate for Silicon.
     """