Skip to content

Commit 37b4e23

Browse files
authored
Merge pull request #839 from CadQuery/marcus7070/introspective-example-note
doc/primer.rst: introspective example additional note
2 parents 032aaea + f817939 commit 37b4e23

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

doc/primer.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -560,14 +560,14 @@ another :class:`~cadquery.Workplane` method).
560560

561561
The next step is to extrude this circle and create a cylindrical protrusion::
562562

563-
part = part.extrude(1)
563+
part = part.extrude(1, clean=False)
564564

565565
Now:
566566

567567
.. code-block:: none
568568
569569
Workplane object at 0xafd0:
570-
parent: Workplane object at 0x6df0
570+
parent: Workplane object at 0xe790
571571
plane: Plane object at 0x3e80:
572572
origin: (0.5, 0.0, 0.0)
573573
z direction: (1.0, 0.0, 0.0)
@@ -582,6 +582,16 @@ The :meth:`~cadquery.Workplane.extrude` method has cleared all the pending wires
582582
that is shown in the 3D view above.
583583

584584

585+
.. note::
586+
The :meth:`~cadquery.Workplane.extrude` has an argument for ``clean`` which defaults to ``True``.
587+
This extrudes the pending wires (creating a new :class:`~cadquery.Workplane` object), then runs
588+
the :meth:`~cadquery.Workplane.clean` method to refine the result, creating another
589+
:class:`~cadquery.Workplane`. If you were to run the example with the default
590+
``clean=True`` then you would see an intermediate
591+
:class:`~cadquery.Workplane` object in :attr:`~cadquery.Workplane.parent`
592+
rather than the object from the previous step.
593+
594+
585595
Assemblies
586596
----------
587597

0 commit comments

Comments
 (0)