Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): typo; unclear description #692

Merged
merged 1 commit into from
Jul 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions boxes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
"""

Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions boxes/edges.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions boxes/generators/gridfinitytraylayout.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions boxes/generators/photoframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions boxes/walledges.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
"""
Expand Down