Skip to content

Commit 7f649f7

Browse files
authored
Update cq.py
As a user in the discord pointed it, the workplane method docs could be somehow not clear about what is the Z direction. I removed the future enchancement that have been added since. I also removed things that seemed odd and outdated to me feel free to revert the change if it was a mistake
1 parent a6cbf22 commit 7f649f7

File tree

1 file changed

+4
-12
lines changed

1 file changed

+4
-12
lines changed

cadquery/cq.py

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -503,15 +503,15 @@ def workplane(
503503
"""
504504
Creates a new 2D workplane, located relative to the first face on the stack.
505505
506-
:param offset: offset for the work plane in the Z direction. Default
507-
:param invert: invert the Z direction from that of the face.
506+
:param offset: offset for the workplane in it's normal direction . Default
507+
:param invert: invert the normal direction from that of the face.
508508
:param centerOption: how local origin of workplane is determined.
509509
:param origin: origin for plane center, requires 'ProjectedOrigin' centerOption.
510510
:type offset: float or None=0.0
511511
:type invert: boolean or None=False
512512
:type centerOption: string or None='ProjectedOrigin'
513513
:type origin: Vector or None
514-
:rtype: Workplane object ( which is a subclass of CQ )
514+
:rtype: Workplane object
515515
516516
The first element on the stack must be a face, a set of
517517
co-planar faces or a vertex. If a vertex, then the parent
@@ -527,7 +527,7 @@ def workplane(
527527
face(s) or vertex (vertices). 'ProjectedOrigin' uses by default the current origin
528528
or the optional origin parameter (if specified) and projects it onto the plane
529529
defined by the selected face(s).
530-
* The Z direction will be normal to the plane of the face,computed
530+
* The Z direction will be the normal of the face,computed
531531
at the center point.
532532
* The X direction will be parallel to the x-y plane. If the workplane is parallel to
533533
the global x-y plane, the x direction of the workplane will co-incide with the
@@ -537,14 +537,6 @@ def workplane(
537537
of the face ( IE, offset=0). Occasionally, it is useful to define a face offset from
538538
an existing surface, and even more rarely to define a workplane based on a face that is
539539
not planar.
540-
541-
To create a workplane without first having a face, use the Workplane() method.
542-
543-
Future Enhancements:
544-
* Allow creating workplane from planar wires
545-
* Allow creating workplane based on an arbitrary point on a face, not just the center.
546-
For now you can work around by creating a workplane and then offsetting the center
547-
afterwards.
548540
"""
549541

550542
def _isCoPlanar(f0, f1):

0 commit comments

Comments
 (0)