diff --git a/cadquery/cq.py b/cadquery/cq.py index 60f664791..7ce014c55 100644 --- a/cadquery/cq.py +++ b/cadquery/cq.py @@ -3245,9 +3245,10 @@ def union( def __or__(self: T, toUnion: Union["Workplane", Solid, Compound]) -> T: """ Syntactic sugar for union. - Notice that `r = a | b` is equivalent to `r = a.union(b)` and `r = a + b`. + Notice that :code:`r = a | b` is equivalent to :code:`r = a.union(b)` and :code:`r = a + b`. Example:: + Box = Workplane("XY").box(1, 1, 1, centered=(False, False, False)) Sphere = Workplane("XY").sphere(1) result = Box | Sphere @@ -3257,7 +3258,7 @@ def __or__(self: T, toUnion: Union["Workplane", Solid, Compound]) -> T: def __add__(self: T, toUnion: Union["Workplane", Solid, Compound]) -> T: """ Syntactic sugar for union. - Notice that `r = a + b` is equivalent to `r = a.union(b)` and `r = a | b`. + Notice that :code:`r = a + b` is equivalent to :code:`r = a.union(b)` and :code:`r = a | b`. """ return self.union(toUnion) @@ -3296,7 +3297,7 @@ def cut( def __sub__(self: T, toUnion: Union["Workplane", Solid, Compound]) -> T: """ Syntactic sugar for cut. - Notice that `r = a - b` is equivalent to `r = a.cut(b)`. + Notice that :code:`r = a - b` is equivalent to :code:`r = a.cut(b)`. Example:: @@ -3341,7 +3342,7 @@ def intersect( def __and__(self: T, toUnion: Union["Workplane", Solid, Compound]) -> T: """ Syntactic sugar for intersect. - Notice that `r = a & b` is equivalent to `r = a.intersect(b)`. + Notice that :code:`r = a & b` is equivalent to :code:`r = a.intersect(b)`. Example::