Skip to content

Commit 488f205

Browse files
committed
Merge branch 'doc_improvements' into dev
2 parents 07eb6c2 + c5b58d6 commit 488f205

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

cadscript/__init__.py

+22-11
Original file line numberDiff line numberDiff line change
@@ -152,18 +152,29 @@ def make_extrude(plane: Union[ConstructionPlane, str],
152152
Body: The extruded body.
153153
154154
Remarks:
155-
The places are defined as follows. Directions refer to
155+
The planes are defined as follows. Directions refer to
156156
the global directions.
157-
=========== ======= ======= ======
158-
Plane xDir yDir zDir
159-
=========== ======= ======= ======
160-
XY +x +y +z
161-
YZ +y +z +x
162-
ZX +z +x +y
163-
XZ +x +z -y
164-
YX +y +x -z
165-
ZY +z +y -x
166-
=========== ======= ======= ======
157+
158+
+-----------+-------+-------+-------+
159+
| Plane | xDir | yDir | zDir |
160+
+===========+=======+=======+=======+
161+
| XY | +x | +y | +z |
162+
+-----------+-------+-------+-------+
163+
| YZ | +y | +z | +x |
164+
+-----------+-------+-------+-------+
165+
| ZX | +z | +x | +y |
166+
+-----------+-------+-------+-------+
167+
| XZ | +x | +z | -y |
168+
+-----------+-------+-------+-------+
169+
| YX | +y | +x | -z |
170+
+-----------+-------+-------+-------+
171+
| ZY | +z | +y | -x |
172+
+-----------+-------+-------+-------+
173+
174+
Please note that the "XZ" plane has its normal in negative y direction.
175+
176+
To avoid confusion, it is recommended to use the
177+
:meth:`make_extrude_x`, :meth:`make_extrude_y` or :meth:`make_extrude_z` functions
167178
"""
168179
if isinstance(plane, ConstructionPlane):
169180
wp = plane.cq()

0 commit comments

Comments
 (0)