Skip to content

Commit 9217b3f

Browse files
committed
docstring update
1 parent 82b7f58 commit 9217b3f

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

cadquery/cq.py

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2405,7 +2405,7 @@ def each(
24052405
:param callBackFunction: the function to call for each item on the current stack.
24062406
:param useLocalCoordinates: should values be converted from local coordinates first?
24072407
:type useLocalCoordinates: boolean
2408-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
2408+
:param combine: True or "a" to combine the resulting solid with parent solids if found, "cut" or "s" to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
24092409
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
24102410
24112411
@@ -2462,7 +2462,7 @@ def eachpoint(
24622462
24632463
:param useLocalCoordinates: should points be in local or global coordinates
24642464
:type useLocalCoordinates: boolean
2465-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
2465+
:param combine: True or "a" to combine the resulting solid with parent solids if found, "cut" or "s" to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
24662466
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
24672467
24682468
@@ -2976,7 +2976,7 @@ def twistExtrude(
29762976
29772977
:param distance: the distance to extrude normal to the workplane
29782978
:param angle: angle (in degrees) to rotate through the extrusion
2979-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
2979+
:param combine: True or "a" to combine the resulting solid with parent solids if found, "cut" or "s" to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
29802980
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
29812981
:return: a CQ object with the resulting solid selected.
29822982
"""
@@ -3014,20 +3014,17 @@ def extrude(
30143014
"""
30153015
Use all un-extruded wires in the parent chain to create a prismatic solid.
30163016
3017-
:param until: the distance to extrude, normal to the workplane plane
30183017
:param until: The distance to extrude, normal to the workplane plane. When a float is
30193018
passed, the extrusion extends this far and a negative value is in the opposite direction
30203019
to the normal of the plane. The string "next" extrudes until the next face orthogonal to
30213020
the wire normal. "last" extrudes to the last face. If a object of type Face is passed then
3022-
the extrusion will extend until this face.
3023-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
3021+
the extrusion will extend until this face. **Note that the Workplane must contain a Solid for extruding to a given face.**
3022+
:param combine: True or "a" to combine the resulting solid with parent solids if found, "cut" or "s" to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
30243023
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
30253024
:param boolean both: extrude in both directions symmetrically
30263025
:param float taper: angle for optional tapered extrusion
30273026
:return: a CQ object with the resulting solid selected.
30283027
3029-
extrude always *adds* material to a part.
3030-
30313028
The returned object is always a CQ object, and depends on whether combine is True, and
30323029
whether a context solid is already defined:
30333030
@@ -3085,8 +3082,7 @@ def revolve(
30853082
:type axisStart: tuple, a two tuple
30863083
:param axisEnd: the end point of the axis of rotation
30873084
:type axisEnd: tuple, a two tuple
3088-
:param combine: True to combine the resulting solid with parent solids if found.
3089-
:type combine: boolean or string, defines how the result of the operation is combined with the base solid
3085+
:param combine: True or "a" to combine the resulting solid with parent solids if found, "cut" or "s" to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
30903086
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
30913087
:return: a CQ object with the resulting solid selected.
30923088
@@ -3151,7 +3147,7 @@ def sweep(
31513147
31523148
:param path: A wire along which the pending wires will be swept
31533149
:param boolean multiSection: False to create multiple swept from wires on the chain along path. True to create only one solid swept along path with shape following the list of wires on the chain
3154-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
3150+
:param combine: True or "a" to combine the resulting solid with parent solids if found, "cut" or "s" to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
31553151
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
31563152
:param transition: handling of profile orientation at C1 path discontinuities. Possible values are {'transformed','round', 'right'} (default: 'right').
31573153
:param normal: optional fixed normal for extrusion
@@ -3521,7 +3517,13 @@ def loft(
35213517
) -> T:
35223518
"""
35233519
Make a lofted solid, through the set of wires.
3520+
3521+
:param boolean ruled: When set to `True` connects each section linearly and without continuity
3522+
:param combine: True or "a" to combine the resulting solid with parent solids if found, "cut" or "s" to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
3523+
:param boolean clean: call :py:meth:`clean` afterwards to have a clean shape
3524+
35243525
:return: a Workplane object containing the created loft
3526+
35253527
"""
35263528

35273529
if self.ctx.pendingWires:
@@ -4160,7 +4162,7 @@ def text(
41604162
:param distance: the distance to extrude or cut, normal to the workplane plane
41614163
:type distance: float, negative means opposite the normal direction
41624164
:param cut: True to cut the resulting solid from the parent solids if found
4163-
:param boolean or string combine: True to combine the resulting solid with parent solids if found, "cut" to remove the resulting solid from the parent solids if found.
4165+
:param combine: True or "a" to combine the resulting solid with parent solids if found, "cut" or "s" to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
41644166
:param clean: call :py:meth:`clean` afterwards to have a clean shape
41654167
:param font: font name
41664168
:param fontPath: path to font file

0 commit comments

Comments
 (0)