corrected typo in the docstrings

Author: jewettaijfc

tidy3d/components/base_sim/simulation.py

@@ -277,7 +277,7 @@ def plot(
         fill_structures : bool = True
             Whether to fill structures with color or just draw outlines.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
         Returns
         -------
         matplotlib.axes._subplots.Axes
@@ -338,7 +338,7 @@ def plot_sources(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -389,7 +389,7 @@ def plot_monitors(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -509,7 +509,7 @@ def plot_boundaries(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
         **kwargs
             Optional keyword arguments passed to the matplotlib ``LineCollection``.
             For details on accepted values, refer to
@@ -553,7 +553,7 @@ def plot_structures(
         fill : bool = True
             Whether to fill structures with color or just draw outlines.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -614,7 +614,7 @@ def plot_structures_eps(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -684,7 +684,7 @@ def plot_structures_heat_conductivity(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------

tidy3d/components/eme/simulation.py

@@ -472,7 +472,7 @@ def plot(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------

tidy3d/components/mode/mode_solver.py

@@ -345,7 +345,7 @@ def _get_solver_grid(
         truncate_symmetry : bool = True
             Truncate to symmetry quadrant if symmetry present.
         transpose : bool = False
-            Swap the coordinates in the plane. (This overrides the default lexicographic axis order).
+            Swap the coordinates in the plane. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -2109,7 +2109,7 @@ def plot(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -2165,7 +2165,7 @@ def plot_eps(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -2230,7 +2230,7 @@ def plot_structures_eps(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -2279,7 +2279,7 @@ def plot_grid(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
         **kwargs
             Optional keyword arguments passed to the matplotlib ``LineCollection``.
             For details on accepted values, refer to
@@ -2430,7 +2430,7 @@ def plot_pml(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------

tidy3d/components/scene.py

@@ -425,7 +425,7 @@ def plot(
         fill_structures : bool = True
             Whether to fill structures with color or just draw outlines.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -471,7 +471,7 @@ def plot_structures(
         fill : bool = True
             Whether to fill structures with color or just draw outlines.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -611,7 +611,7 @@ def _set_plot_bounds(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -650,7 +650,7 @@ def _get_structures_2dbox(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -786,7 +786,7 @@ def plot_eps(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -856,7 +856,7 @@ def plot_structures_eps(
             e.g. ``"xx"``, ``"yy"``, ``"zz"``, ``"xy"``, ``"yz"``, ...
             Defaults to ``None``, which returns the average of the diagonal values.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -940,7 +940,7 @@ def plot_structures_property(
             e.g. ``"xx"``, ``"yy"``, ``"zz"``, ``"xy"``, ``"yz"``, ...
             Defaults to ``None``, which returns the average of the diagonal values.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -1404,7 +1404,7 @@ def plot_heat_charge_property(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -1461,7 +1461,7 @@ def plot_structures_heat_conductivity(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -1531,7 +1531,7 @@ def plot_structures_heat_charge_property(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -1750,7 +1750,7 @@ def plot_heat_conductivity(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------

tidy3d/components/simulation.py

@@ -479,7 +479,7 @@ def plot(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -576,7 +576,7 @@ def plot_eps(
         eps_lim : Tuple[float, float] = None
             Custom limits for eps coloring.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -685,7 +685,7 @@ def plot_structures_eps(
         eps_lim : Tuple[float, float] = None
             Custom limits for eps coloring.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -755,7 +755,7 @@ def plot_pml(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -918,7 +918,7 @@ def plot_lumped_elements(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -969,7 +969,7 @@ def plot_grid(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
         **kwargs
             Optional keyword arguments passed to the matplotlib ``LineCollection``.
             For details on accepted values, refer to
@@ -1111,7 +1111,7 @@ def plot_boundaries(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
         **kwargs
             Optional keyword arguments passed to the matplotlib ``LineCollection``.
             For details on accepted values, refer to

tidy3d/components/structure.py

@@ -165,7 +165,7 @@ def plot(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
         **patch_kwargs
             Optional keyword arguments passed to the matplotlib patch plotting of structure.
             For details on accepted values, refer to

tidy3d/components/tcad/simulation/heat.py

@@ -99,7 +99,7 @@ def plot_heat_conductivity(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------

tidy3d/components/tcad/simulation/heat_charge.py

@@ -994,7 +994,7 @@ def plot_property(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -1100,7 +1100,7 @@ def plot_heat_conductivity(
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -1161,7 +1161,7 @@ def plot_boundaries(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -1473,7 +1473,7 @@ def _construct_heat_charge_boundaries(
         boundary_spec : List[HeatBoundarySpec]
             list of boundary conditions associated with structures.
         transpose : bool = False
-            Swap the boundary-box coordinates in the plane. (This overrides the default lexicographic axis order).
+            Swap the boundary-box coordinates in the plane. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -1559,7 +1559,7 @@ def plot_sources(
         ax : matplotlib.axes._subplots.Axes = None
             Matplotlib axes to plot on, if not specified, one is created.
         transpose : bool = False
-            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order).
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------