added docstrings and removed the "transpose" argument from several functions where it wasn't needed.

Author: jewettaijfc

tidy3d/components/base_sim/simulation.py

@@ -276,6 +276,8 @@ def plot(
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         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).
         Returns
         -------
         matplotlib.axes._subplots.Axes
@@ -335,6 +337,8 @@ def plot_sources(
             Opacity of the sources, If ``None`` uses Tidy3d default.
         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).
 
         Returns
         -------
@@ -384,6 +388,8 @@ def plot_monitors(
             Opacity of the sources, If ``None`` uses Tidy3d default.
         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).
 
         Returns
         -------
@@ -502,6 +508,8 @@ def plot_boundaries(
             position of plane in z direction, only one of x, y, z must be specified to define plane.
         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).
         **kwargs
             Optional keyword arguments passed to the matplotlib ``LineCollection``.
             For details on accepted values, refer to
@@ -544,6 +552,9 @@ def plot_structures(
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
         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).
+
         Returns
         -------
         matplotlib.axes._subplots.Axes
@@ -602,6 +613,8 @@ def plot_structures_eps(
             The x range if plotting on xy or xz planes, y range if plotting on yz plane.
         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).
 
         Returns
         -------
@@ -670,6 +683,8 @@ def plot_structures_heat_conductivity(
             The x range if plotting on xy or xz planes, y range if plotting on yz plane.
         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).
 
         Returns
         -------

tidy3d/components/eme/simulation.py

@@ -471,6 +471,8 @@ def plot(
             The x range if plotting on xy or xz planes, y range if plotting on yz plane.
         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).
 
         Returns
         -------

tidy3d/components/geometry/base.py

@@ -252,6 +252,8 @@ def intersections_plane(
             Position of plane in y direction, only one of x,y,z can be specified to define plane.
         z : float = None
             Position of plane in z direction, only one of x,y,z can be specified to define plane.
+        transpose : bool = False
+            Optional: Swap the coordinates in the plane. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -273,6 +275,13 @@ def intersections_2dbox(self, plane: Box, transpose: bool = False) -> list[Shape
         """Returns list of shapely geometries representing the intersections of the geometry with
         a 2D box.
 
+        Parameters
+        ----------
+        plane : Box
+            Plane specification.
+        transpose : bool = False
+            Optional: Swap the coordinates in the plane. (This overrides the default lexicographic axis order.)
+
         Returns
         -------
         List[shapely.geometry.base.BaseGeometry]
@@ -454,6 +463,8 @@ def _pop_bounds(
         ----------
         axis : int
             Integer index into 'xyz' (0,1,2).
+        transpose : bool = False
+            Optional: Swap the coordinates in the plane. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -523,6 +534,8 @@ def plot(
             Specify units to use for axis labels, tick labels, and the title.
         viz_spec : VisualizationSpec = None
             Plotting parameters associated with a medium to use instead of defaults.
+        transpose : bool = False
+            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
@@ -605,6 +618,8 @@ def _get_plot_labels(axis: Axis, transpose: bool = False) -> tuple[str, str]:
         ----------
         axis : int
             Integer index into 'xyz' (0,1,2).
+        transpose : bool = False
+            Optional: Swap horizontal and vertical plot labels. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -635,7 +650,7 @@ def _get_plot_limits(
         return (xmin - buffer, xmax + buffer), (ymin - buffer, ymax + buffer)
 
     def add_ax_lims(self, axis: Axis, ax: Ax, buffer: float = PLOT_BUFFER, transpose: bool = False) -> Ax:
-        """Sets the x,y limits based on ``self.bounds``.
+        """Sets the horizontal and vertical axis limits based on ``self.bounds``.
 
         Parameters
         ----------
@@ -645,6 +660,8 @@ def add_ax_lims(self, axis: Axis, ax: Ax, buffer: float = PLOT_BUFFER, transpose
             Matplotlib axes to add labels and limits on.
         buffer : float = 0.3
             Amount of space to place around the limits on the + and - sides.
+        transpose : bool = False
+            Optional: Swap horizontal and vertical axis limits. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -685,6 +702,8 @@ def add_ax_labels_and_title(
         plot_length_units : LengthUnit = None
             When set to a supported ``LengthUnit``, plots will be produced with annotated axes
             and title with the proper units.
+        transpose : bool = False
+            Optional: Swap horizontal and vertical axis labels. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -1772,6 +1791,8 @@ def intersections_plane(
             Position of plane in y direction, only one of x,y,z can be specified to define plane.
         z : float
             Position of plane in z direction, only one of x,y,z can be specified to define plane.
+        transpose : bool = False
+            Optional: Swap the coordinates in the plane before calculating intersections.
 
         Returns
         -------
@@ -1795,8 +1816,8 @@ def _intersections_normal(self, z: float, transpose: bool = False) -> list:
         ----------
         z : float
             Position along the axis normal to slab
-        transpose : bool
-            Optional: Swap the order of the x and y axis in the geometry data.
+        transpose : bool = False
+            Optional: Swap the coordinates in the plane before calculating intersections.
 
         Returns
         -------
@@ -1816,8 +1837,8 @@ def _intersections_side(self, position: float, axis: Axis, transpose: bool = Fal
             Position along axis.
         axis : int
             Integer index into 'xyz' (0,1,2).
-        transpose : bool
-            Optional: Swap the order of the remaining two axes (the axes not equal to axis).
+        transpose : bool = False
+            Optional: Swap the coordinates in the perpendicular plane before calculating intersections.
 
         Returns
         -------
@@ -2155,8 +2176,8 @@ def intersections_plane(
             Position of plane in y direction, only one of x,y,z can be specified to define plane.
         z : float = None
             Position of plane in z direction, only one of x,y,z can be specified to define plane.
-        transpose: bool = False
-            Optional: Swap the order of the coordinates in the two remaining (unspecified) axis?
+        transpose : bool = False
+            Optional: Swap the coordinates in the plane before calculating intersections.
 
         Returns
         -------
@@ -2338,6 +2359,8 @@ def _plot_arrow(
             If True, plots an arrow pointing in direction and one in -direction.
         arrow_base : :class:`.Coordinate` = None
             Custom base of the arrow. Uses the geometry's center if not provided.
+        transpose : bool = False
+            Swap horizontal and vertical axes. (This overrides the default lexicographic axis order.)
 
         Returns
         -------
@@ -3061,6 +3084,8 @@ def intersections_plane(
             Position of plane in y direction, only one of x,y,z can be specified to define plane.
         z : float = None
             Position of plane in z direction, only one of x,y,z can be specified to define plane.
+        transpose : bool = False
+            Optional: Swap the coordinates in the plane before calculating intersections.
 
         Returns
         -------
@@ -3273,6 +3298,8 @@ def intersections_plane(
             Position of plane in y direction, only one of x,y,z can be specified to define plane.
         z : float = None
             Position of plane in z direction, only one of x,y,z can be specified to define plane.
+        transpose : bool = False
+            Optional: Swap the coordinates in the plane before calculating intersections.
 
         Returns
         -------

tidy3d/components/geometry/mesh.py

@@ -570,6 +570,8 @@ def intersections_plane(
             Position of plane in y direction, only one of x,y,z can be specified to define plane.
         z : float = None
             Position of plane in z direction, only one of x,y,z can be specified to define plane.
+        transpose : bool = False
+            Optional: Swap the coordinates in the plane before calculating intersections.
 
         Returns
         -------

tidy3d/components/geometry/polyslab.py

@@ -637,7 +637,7 @@ def _intersections_normal(self, z: float, transpose: bool = False):
         z : float
             Position along the axis normal to slab.
         transpose : bool = False
-            Optional: Swap the planar (XY) coordinates?
+            Optional: Swap the coordinates in the plane before calculating intersections.
 
         Returns
         -------
@@ -686,7 +686,7 @@ def _intersections_side(self, position, axis, transpose: bool = False) -> list:
         axis : int
             Integer index into 'xyz' (0,1,2).
         transpose : bool = False
-            Optional: Swap the coordinates in the plane orthogonal to the axis?
+            Optional: Swap the coordinates in the perpendicular plane before calculating intersections.
 
         Returns
         -------

tidy3d/components/geometry/primitives.py

@@ -481,7 +481,7 @@ def _intersections_normal(self, z: float, transpose: bool = False):
         z : float
             Position along the axis normal to slab
         transpose : bool = False
-            Optional: Swap the x and y coordinates?
+            Optional: Swap the coordinates in slab's plane before calculating intersections.
 
         Returns
         -------
@@ -514,7 +514,7 @@ def _intersections_side(self, position, axis, transpose: bool = False):
         axis : int
             Integer index into 'xyz' (0, 1, 2).
         transpose : bool = False
-            Optional: Swap the coordinates in the plane orthogonal to the axis?
+            Optional: Swap the coordinates in the perpendicular plane before calculating intersections.
 
         Returns
         -------
@@ -762,7 +762,7 @@ def _local_to_global_side_cross_section(
         coords : List[float, float]
             The value in the planar coordinate.
         transpose : bool = False
-            Optional: Swap the coordinates in the plane before converting them?
+            Optional: Swap the coordinates in the perpendicular plane before calculating intersections.
 
         Returns
         -------

tidy3d/components/geometry/utils.py

@@ -55,6 +55,8 @@ def merging_geometries_on_plane(
         Plane specification.
     property_list : List = None
         Property value for each structure.
+    transpose : bool = False
+            Optional: Swap the coordinates in the plane. (This overrides the default lexicographic axis order.)
 
     Returns
     -------