Skip to content

Commit 0ae13ec

Browse files
committed
improve docs
1 parent 707cc72 commit 0ae13ec

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

cadscript/__init__.py

+8-3
Original file line numberDiff line numberDiff line change
@@ -295,10 +295,15 @@ def make_revolve(axis: AxisType,
295295
angle (float, optional): The angle of revolution in degrees.
296296
Can also be a tuple of two floats to revolve between two angles.
297297
Defaults to 360.
298+
Revolution will be counter-clockwise around the axis of revolution (right-hand rule with axis in
299+
positive direction), starting from the start axis.
298300
start_axis (str, optional): The start axis of the revolution. Doesn't have an effect if angle is 360.
299-
Can be one of "X", "Y", "Z", "+X", "+Y", "+Z", "-X", "-Y", "-Z".
300-
If not specified, the start axis will be "+Y" for the "X" axis, "+Z" for the "Y" axis and "+X" for the "Z" axis.
301-
Revolution will be counter-clockwise around the axis (right-hand rule with axis in positive direction).
301+
Can be one of "X", "Y", "Z", "+X", "+Y", "+Z", "-X", "-Y", "-Z". "X" and "+X" are equivalent,
302+
describing the global x axis in positive direction. "-X" describes the global x axis in negative
303+
direction. The same applies to "Y" and "Z".
304+
If not specified, the start axis will be "+Y" for the "X" axis, "+Z" for the "Y" axis and
305+
"+X" for the "Z" axis.
306+
302307
303308
Returns:
304309
Body: The revolved body.

0 commit comments

Comments
 (0)