Skip to content

Commit

Permalink
Merge pull request #574 from RubenRubens/docs
Browse files Browse the repository at this point in the history
Fix split docs
  • Loading branch information
jmwright authored Jan 13, 2021
2 parents ccf56e6 + 51373fb commit c381e49
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions cadquery/cq.py
Original file line number Diff line number Diff line change
Expand Up @@ -232,21 +232,22 @@ def _collectProperty(self, propName: str) -> List[CQObject]:

def split(self, keepTop: bool = False, keepBottom: bool = False) -> "Workplane":
"""
Splits a solid on the stack into two parts, optionally keeping the separate parts.
:param boolean keepTop: True to keep the top, False or None to discard it
:param boolean keepBottom: True to keep the bottom, False or None to discard it
:raises: ValueError if keepTop and keepBottom are both false.
:raises: ValueError if there is not a solid in the current stack or the parent chain
:returns: CQ object with the desired objects on the stack.
The most common operation splits a solid and keeps one half. This sample creates
split bushing::
#drill a hole in the side
c = Workplane().box(1,1,1).faces(">Z").workplane().circle(0.25).cutThruAll()F
#now cut it in half sideways
c.faces(">Y").workplane(-0.5).split(keepTop=True)
Splits a solid on the stack into two parts, optionally keeping the separate parts.
:param boolean keepTop: True to keep the top, False or None to discard it
:param boolean keepBottom: True to keep the bottom, False or None to discard it
:raises: ValueError if keepTop and keepBottom are both false.
:raises: ValueError if there is not a solid in the current stack or the parent chain
:returns: CQ object with the desired objects on the stack.
The most common operation splits a solid and keeps one half. This sample creates
split bushing::
# drill a hole in the side
c = Workplane().box(1,1,1).faces(">Z").workplane().circle(0.25).cutThruAll()
# now cut it in half sideways
c = c.faces(">Y").workplane(-0.5).split(keepTop=True)
"""

solid = self.findSolid()
Expand Down

0 comments on commit c381e49

Please sign in to comment.