Merge pull request #844 from revolter/patch-2

Doc fixes (add wedge)

cadquery/cq.py

@@ -2942,9 +2942,9 @@ def twistExtrude(
  ) -> T:
  """
  Extrudes a wire in the direction normal to the plane, but also twists by the specified
- angle over the length of the extrusion
+ angle over the length of the extrusion.
 
- The center point of the rotation will be the center of the workplane
+ The center point of the rotation will be the center of the workplane.
 
  See extrude for more details, since this method is the same except for the the addition
  of the angle. In fact, if angle=0, the result is the same as a linear extrude.
@@ -3312,7 +3312,7 @@ def cut(
  self: T, toCut: Union["Workplane", Solid, Compound], clean: bool = True
  ) -> T:
  """
- Cuts the provided solid from the current solid, IE, perform a solid subtraction
+ Cuts the provided solid from the current solid, IE, perform a solid subtraction.
 
  :param toCut: object to cut
  :type toCut: a solid object, or a CQ object having a solid,
@@ -3876,7 +3876,7 @@ def sphere(
  clean: bool = True,
  ) -> T:
  """
- Returns a 3D sphere with the specified radius for each point on the stack
+ Returns a 3D sphere with the specified radius for each point on the stack.
 
  :param radius: The radius of the sphere
  :type radius: float > 0
@@ -4013,6 +4013,8 @@ def wedge(
  clean: bool = True,
  ) -> T:
  """
+ Returns a 3D wedge with the specified dimensions for each point on the stack.
+
  :param dx: Distance along the X axis
  :param dy: Distance along the Y axis
  :param dz: Distance along the Z axis
@@ -4114,7 +4116,7 @@ def text(
  valign: Literal["center", "top", "bottom"] = "center",
  ) -> T:
  """
- Create a 3D text
+ Returns a 3D text.
 
  :param txt: text to be rendered
  :param fontsize: size of the font in model units

doc/apireference.rst

@@ -169,6 +169,7 @@ Some 3D operations also require an active 2D workplane, but some do not.
  Workplane.cutThruAll
  Workplane.box
  Workplane.sphere
+ Workplane.wedge
  Workplane.cylinder
  Workplane.union
  Workplane.combine

doc/primer.rst

@@ -72,7 +72,7 @@ See :ref:`2dOperations` to learn more.
 3D Construction
 ---------------------------
 
-You can construct 3D primitives such as boxes, spheres, wedges, and cylinders directly. You can also sweep, extrude,
+You can construct 3D primitives such as boxes, wedges, cylinders and spheres directly. You can also sweep, extrude,
 and loft 2D geometry to form 3D features. Of course the basic primitive operations are also available.
 
 See :ref:`3doperations` to learn more.