From 48ffc9709ea8e5f7d1e2467f1f658170544bf849 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 28 Jul 2024 20:19:02 -0700 Subject: [PATCH] double quotes for docstrings --- masque/shapes/arc.py | 12 ++++++------ masque/shapes/path.py | 8 ++++---- masque/shapes/polygon.py | 8 ++++---- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/masque/shapes/arc.py b/masque/shapes/arc.py index da10d0d..4213229 100644 --- a/masque/shapes/arc.py +++ b/masque/shapes/arc.py @@ -308,7 +308,7 @@ class Arc(Shape): return [poly] def get_bounds_single(self) -> NDArray[numpy.float64]: - ''' + """ Equation for rotated ellipse is `x = x0 + a * cos(t) * cos(rot) - b * sin(t) * sin(phi)` `y = y0 + a * cos(t) * sin(rot) + b * sin(t) * cos(rot)` @@ -319,7 +319,7 @@ class Arc(Shape): where -+ is for x, y cases, so that's where the extrema are. If the extrema are innaccessible due to arc constraints, check the arc endpoints instead. - ''' + """ a_ranges = self._angles_to_parameters() mins = [] @@ -424,13 +424,13 @@ class Arc(Shape): )) def get_cap_edges(self) -> NDArray[numpy.float64]: - ''' + """ Returns: ``` [[[x0, y0], [x1, y1]], array of 4 points, specifying the two cuts which [[x2, y2], [x3, y3]]], would create this arc from its corresponding ellipse. ``` - ''' + """ a_ranges = self._angles_to_parameters() mins = [] @@ -454,11 +454,11 @@ class Arc(Shape): return numpy.array([mins, maxs]) + self.offset def _angles_to_parameters(self) -> NDArray[numpy.float64]: - ''' + """ Returns: "Eccentric anomaly" parameter ranges for the inner and outer edges, in the form `[[a_min_inner, a_max_inner], [a_min_outer, a_max_outer]]` - ''' + """ a = [] for sgn in (-1, +1): wh = sgn * self.width / 2 diff --git a/masque/shapes/path.py b/masque/shapes/path.py index bfaf14f..dfd89f1 100644 --- a/masque/shapes/path.py +++ b/masque/shapes/path.py @@ -431,22 +431,22 @@ class Path(Shape): return self def remove_duplicate_vertices(self) -> 'Path': - ''' + """ Removes all consecutive duplicate (repeated) vertices. Returns: self - ''' + """ self.vertices = remove_duplicate_vertices(self.vertices, closed_path=False) return self def remove_colinear_vertices(self) -> 'Path': - ''' + """ Removes consecutive co-linear vertices. Returns: self - ''' + """ self.vertices = remove_colinear_vertices(self.vertices, closed_path=False) return self diff --git a/masque/shapes/polygon.py b/masque/shapes/polygon.py index 1d52489..f6add4d 100644 --- a/masque/shapes/polygon.py +++ b/masque/shapes/polygon.py @@ -415,22 +415,22 @@ class Polygon(Shape): return self def remove_duplicate_vertices(self) -> 'Polygon': - ''' + """ Removes all consecutive duplicate (repeated) vertices. Returns: self - ''' + """ self.vertices = remove_duplicate_vertices(self.vertices, closed_path=True) return self def remove_colinear_vertices(self) -> 'Polygon': - ''' + """ Removes consecutive co-linear vertices. Returns: self - ''' + """ self.vertices = remove_colinear_vertices(self.vertices, closed_path=True) return self