From 94f26399efd3ab84b402cc60cff84df5e0081367 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hasan=20Yavuz=20=C3=96ZDERYA?= Date: Thu, 17 Sep 2015 23:14:47 +0300 Subject: [PATCH] updated documentation of `workplane()` method --- cadquery/CQ.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/cadquery/CQ.py b/cadquery/CQ.py index c9fe07c..6769d40 100644 --- a/cadquery/CQ.py +++ b/cadquery/CQ.py @@ -262,7 +262,6 @@ class CQ(object): def workplane(self, offset=0.0, invert=False): """ - Creates a new 2-D workplane, located relative to the first face on the stack. :param offset: offset for the work plane in the Z direction. Default @@ -271,14 +270,18 @@ class CQ(object): :type invert: boolean or None=False :rtype: Workplane object ( which is a subclass of CQ ) - The first element on the stack must be a face, or a vertex. If a vertex, then the parent - item on the chain immediately before the vertex must be a face. + The first element on the stack must be a face, a set of + co-planar faces or a vertex. If a vertex, then the parent + item on the chain immediately before the vertex must be a + face. The result will be a 2-d working plane with a new coordinate system set up as follows: - * The origin will be located in the *center* of the face, if a face was selected. If a - vertex was selected, the origin will be at the vertex, and located on the face. + * The origin will be located in the *center* of the + face/faces, if a face/faces was selected. If a vertex was + selected, the origin will be at the vertex, and located + on the face. * The Z direction will be normal to the plane of the face,computed at the center point. * The X direction will be parallel to the x-y plane. If the workplane is parallel to