From 2eac7b091dfd9effbe805fdc70e3bc4c4de01b0f Mon Sep 17 00:00:00 2001 From: Rotzbua Date: Wed, 24 Jul 2024 18:33:53 +0200 Subject: [PATCH] fix(docs): typo; unclear description --- boxes/__init__.py | 30 ++++++++++++------------ boxes/edges.py | 4 ++-- boxes/generators/gridfinitytraylayout.py | 4 ++-- boxes/generators/photoframe.py | 4 ++-- boxes/walledges.py | 4 ++-- 5 files changed, 23 insertions(+), 23 deletions(-) diff --git a/boxes/__init__.py b/boxes/__init__.py index d0399f5e9..7c8e86bbd 100755 --- a/boxes/__init__.py +++ b/boxes/__init__.py @@ -1079,7 +1079,7 @@ def handle(self, x, h, hl, r=30): :param x: width in mm :param h: height in mm - :param hl: height if th grip hole + :param hl: height if the grip hole :param r: (Default value = 30) radius of the corners """ d = (x - hl - 2 * r) / 2.0 @@ -1222,8 +1222,8 @@ def circle(self, x, y, r): """ Draw a round disc - :param x: position - :param y: position + :param x: x position + :param y: y position :param r: radius """ r += self.burn @@ -1242,8 +1242,8 @@ def regularPolygonHole(self, x, y, r=0.0, d=0.0, n=6, a=0.0, tabs=0, corner_radi """ Draw a hole in shape of an n-edged regular polygon - :param x: position - :param y: position + :param x: x position + :param y: y position :param r: radius :param n: number of edges :param a: rotation angle @@ -1286,8 +1286,8 @@ def hole(self, x, y, r=0.0, d=0.0, tabs=0): """ Draw a round hole - :param x: position - :param y: position + :param x: x position + :param y: y position :param r: radius """ @@ -1305,8 +1305,8 @@ def rectangularHole(self, x, y, dx, dy, r=0, center_x=True, center_y=True): """ Draw a rectangular hole - :param x: position - :param y: position + :param x: x position + :param y: y position :param dx: width :param dy: height :param r: (Default value = 0) radius of the corners @@ -1328,8 +1328,8 @@ def dHole(self, x, y, r=None, d=None, w=None, rel_w=0.75, angle=0): """ Draw a hole for a shaft with flat edge - D shaped hole - :param x: center position - :param y: center position + :param x: center x position + :param y: center y position :param r: radius (overrides d) :param d: diameter :param w: width measured against flat side in mm @@ -1360,8 +1360,8 @@ def flatHole(self, x, y, r=None, d=None, w=None, rel_w=0.75, angle=0): """ Draw a hole for a shaft with two opposed flat edges - ( ) shaped hole - :param x: center position - :param y: center position + :param x: center x position + :param y: center y position :param r: radius (overrides d) :param d: diameter :param w: width measured against flat side in mm @@ -1396,8 +1396,8 @@ def mountingHole(self, x, y, d_shaft, d_head=0.0, angle=0, tabs=0): """ Draw a pear shaped mounting hole for sliding over a screw head. Total height = 1.5* d_shaft + d_head - :param x: position - :param y: position + :param x: x position + :param y: y position :param d_shaft: diameter of the screw shaft :param d_head: diameter of the screw head :param angle: rotation angle of the hole diff --git a/boxes/edges.py b/boxes/edges.py index 4523dcf49..c9db7d9ed 100644 --- a/boxes/edges.py +++ b/boxes/edges.py @@ -1039,8 +1039,8 @@ def __call__(self, x, y, length, angle=90, bedBolts=None, bedBoltSettings=None): """ Draw holes for a matching finger joint edge - :param x: position - :param y: position + :param x: x position + :param y: y position :param length: length of matching edge :param angle: (Default value = 90) :param bedBolts: (Default value = None) diff --git a/boxes/generators/gridfinitytraylayout.py b/boxes/generators/gridfinitytraylayout.py index 7a9e689ea..0a51eb46c 100644 --- a/boxes/generators/gridfinitytraylayout.py +++ b/boxes/generators/gridfinitytraylayout.py @@ -73,8 +73,8 @@ def rectangularEtching(self, x, y, dx, dy, r=0, center_x=True, center_y=True): """ Draw a rectangular hole - :param x: position - :param y: position + :param x: x position + :param y: y position :param dx: width :param dy: height :param r: (Default value = 0) radius of the corners diff --git a/boxes/generators/photoframe.py b/boxes/generators/photoframe.py index de481f001..65ab9499d 100644 --- a/boxes/generators/photoframe.py +++ b/boxes/generators/photoframe.py @@ -538,8 +538,8 @@ def rectangular_etching(self, x, y, dx, dy, r=0.0, center_x=True, center_y=True) Draw a rectangular etching (from GridfinityTrayLayout.rectangularEtching) Same as rectangularHole, but with no burn margin - :param x: position - :param y: position + :param x: x position + :param y: y position :param dx: width :param dy: height :param r: (Default value = 0) radius of the corners diff --git a/boxes/walledges.py b/boxes/walledges.py index 4fb5c71ef..ae5650e7a 100644 --- a/boxes/walledges.py +++ b/boxes/walledges.py @@ -121,8 +121,8 @@ def __call__(self, x, y, length, angle, **kw): """ Draw holes for a matching WallJoinedEdge - :param x: position - :param y: position + :param x: x position + :param y: y position :param length: length of matching edge :param angle: (Default value = 90) """