Merge pull request #852 from revolter/fix/inconsistent-documentation

Fix inconsistent 2D and 3D spellings

Author: jmwright

cadquery/cq.py

@@ -130,7 +130,7 @@ def popPendingWires(self, errorOnEmpty: bool = True) -> List[Wire]:
 
 class Workplane(object):
     """
-    Defines a coordinate system in space, in which 2-d coordinates can be used.
+    Defines a coordinate system in space, in which 2D coordinates can be used.
 
     :param plane: the plane in which the workplane will be done
     :type plane: a Plane object, or a string in (XY|YZ|XZ|front|back|top|bottom|left|right)
@@ -501,7 +501,7 @@ def workplane(
         origin: Optional[VectorLike] = None,
     ) -> T:
         """
-        Creates a new 2-D workplane, located relative to the first face on the stack.
+        Creates a new 2D workplane, located relative to the first face on the stack.
 
         :param offset:  offset for the work plane in the Z direction. Default
         :param invert:  invert the Z direction from that of the face.
@@ -518,7 +518,7 @@ def workplane(
         item on the chain immediately before the vertex must be a
         face.
 
-        The result will be a 2-d working plane
+        The result will be a 2D working plane
         with a new coordinate system set up as follows:
 
            * The centerOption parameter sets how the center is defined.
@@ -1531,7 +1531,7 @@ def polarArray(
     def pushPoints(self: T, pntList: Iterable[Union[VectorLike, Location]]) -> T:
         """
         Pushes a list of points onto the stack as vertices.
-        The points are in the 2-d coordinate space of the workplane face
+        The points are in the 2D coordinate space of the workplane face
 
         :param pntList: a list of points to push onto the stack
         :type pntList: list of 2-tuples, in *local* coordinates
@@ -2356,11 +2356,11 @@ def wire(self: T, forConstruction: bool = False) -> T:
         :param forConstruction: whether the wire should be used to make a solid, or if it is just
             for reference
 
-        This method is primarily of use to plugin developers making utilities for 2-d construction.
-        This method should be called when a user operation implies that 2-d construction is
+        This method is primarily of use to plugin developers making utilities for 2D construction.
+        This method should be called when a user operation implies that 2D construction is
         finished, and we are ready to begin working in 3d.
 
-        SEE '2-d construction concepts' for a more detailed explanation of how CadQuery handles
+        SEE '2D construction concepts' for a more detailed explanation of how CadQuery handles
         edges, wires, etc.
 
         Any non edges will still remain.
@@ -2693,11 +2693,11 @@ def polyline(
 
     def close(self: T) -> T:
         """
-        End 2-d construction, and attempt to build a closed wire.
+        End 2D construction, and attempt to build a closed wire.
 
         :return: a CQ object with a completed wire on the stack, if possible.
 
-        After 2-d drafting with methods such as lineTo, threePointArc,
+        After 2D drafting with methods such as lineTo, threePointArc,
         tangentArcPoint and polyline, it is necessary to convert the edges
         produced by these into one or more wires.
 

cadquery/occ_impl/exporters/svg.py

@@ -223,7 +223,7 @@ def getSVG(shape, opts=None):
     hidden = list(map(Shape, hidden))
     (hiddenPaths, visiblePaths) = getPaths(visible, hidden)
 
-    # get bounding box -- these are all in 2-d space
+    # get bounding box -- these are all in 2D space
     bb = Compound.makeCompound(hidden + visible).BoundingBox()
 
     # width pixels for x, height pixels for y

cadquery/occ_impl/geom.py

@@ -27,7 +27,7 @@
 class Vector(object):
     """Create a 3-dimensional vector
 
-        :param args: a 3-d vector, with x-y-z parts.
+        :param args: a 3D vector, with x-y-z parts.
 
         you can either provide:
             * nothing (in which case the null vector is return)
@@ -377,7 +377,7 @@ class Plane(object):
     A 2D coordinate system in space, with the x-y axes on the plane, and a
     particular point as the origin.
 
-    A plane allows the use of 2-d coordinates, which are later converted to
+    A plane allows the use of 2D coordinates, which are later converted to
     global, 3d coordinates when the operations are complete.
 
     Frequently, it is not necessary to create work planes, as they can be
@@ -587,7 +587,7 @@ def setOrigin2d(self, x, y):
         :param float y: offset in the y direction
         :return: void
 
-        The new coordinates are specified in terms of the current 2-d system.
+        The new coordinates are specified in terms of the current 2D system.
         As an example:
 
         p = Plane.XY()
@@ -609,9 +609,9 @@ def toLocalCoords(self, obj):
 
 
         Most of the time, the z-coordinate returned will be zero, because most
-        operations based on a plane are all 2-d. Occasionally, though, 3-d
+        operations based on a plane are all 2D. Occasionally, though, 3D
         points outside of the current plane are transformed. One such example is
-        :py:meth:`Workplane.box`, where 3-d corners of a box are transformed to
+        :py:meth:`Workplane.box`, where 3D corners of a box are transformed to
         orient the box in space correctly.
 
         """

doc/_static/cadquery_cheatsheet.html

@@ -153,7 +153,7 @@ <h2>Core Classes</h2><br />
           </tr>
           <tr>
             <td>Workplane(inPlane[origin, obj])</td>
-            <td>Defines a coordinate system in space, in which 2-d coordinates can be used.</td>
+            <td>Defines a coordinate system in space, in which 2D coordinates can be used.</td>
           </tr>
         </table>
       </div>

doc/apireference.rst

@@ -6,7 +6,7 @@ CadQuery API Reference
 
 The CadQuery API is made up of 2 main objects:
 
-* **Workplane** -- Wraps a topological entity and provides a 2-D modelling context.
+* **Workplane** -- Wraps a topological entity and provides a 2D modelling context.
 * **Selector** -- Filter and select things
 
 This page lists  methods of these objects grouped by **functional area**
@@ -29,12 +29,12 @@ Creating new workplanes and object chains
 
 .. _2dOperations:
 
-2-d Operations
+2D Operations
 -----------------
 
-Creating 2-d constructs that can be used to create 3 d features.
+Creating 2D constructs that can be used to create 3D features.
 
-All 2-d operations require a **Workplane** object to be created.
+All 2D operations require a **Workplane** object to be created.
 
 .. currentmodule:: cadquery
 
@@ -73,12 +73,12 @@ All 2-d operations require a **Workplane** object to be created.
 
 .. _3doperations:
 
-3-d Operations
+3D Operations
 -----------------
 
-Some 3-d operations also require an active 2-d workplane, but some do not.
+Some 3D operations also require an active 2D workplane, but some do not.
 
-3-d operations that require a 2-d workplane to be active:
+3D operations that require a 2D workplane to be active:
 
 .. autosummary::
 	Workplane.cboreHole
@@ -100,7 +100,7 @@ Some 3-d operations also require an active 2-d workplane, but some do not.
 	Workplane.text
 
 
-3-d operations that do NOT require a 2-d workplane to be active:
+3D operations that do NOT require a 2D workplane to be active:
 
 .. autosummary::
 	Workplane.shell

doc/examples.rst

@@ -112,9 +112,9 @@ Building Profiles using lines and arcs
 --------------------------------------
 
 Sometimes you need to build complex profiles using lines and arcs. This example builds a prismatic
-solid from 2-d operations.
+solid from 2D operations.
 
-2-d operations maintain a current point, which is initially at the origin. Use close() to finish a
+2D operations maintain a current point, which is initially at the origin. Use close() to finish a
 closed curve.
 
 
@@ -281,7 +281,7 @@ needs a complex profile
 Mirroring Symmetric Geometry
 -----------------------------
 
-You can mirror 2-d geometry when your shape is symmetric. In this example we also
+You can mirror 2D geometry when your shape is symmetric. In this example we also
 introduce horizontal and vertical lines, which make for slightly easier coding.
 
 

doc/extending.rst

@@ -103,7 +103,7 @@ are designed to aid in plugin creation:
 
    * :py:meth:`cadquery.Workplane.wire` gathers up all of the edges that have been drawn ( eg, by line, vline, etc ), and
      attempts to combine them into a single wire, which is returned. This should be used when your plugin creates
-     2-d edges, and you know it is time to collect them into a single wire.
+     2D edges, and you know it is time to collect them into a single wire.
 
    * :py:meth:`cadquery.Workplane.plane` provides a reference to the workplane, which allows you to convert between workplane
      coordinates and global coordinates:

doc/roadmap.rst

@@ -29,7 +29,7 @@ implement more constraints
     in plane, on axis, parallel to vector
 
 
-2-d operations
+2D operations
 -------------------
 
 arc construction using relative measures
@@ -47,10 +47,10 @@ trimming
 construction lines
     especially centerlines
 
-2-d fillets
+2D fillets
     for a rectangle, or for consecutive selected lines
 
-2-d chamfers
+2D chamfers
     based on rectangles, polygons, polylines, or adjacent selected lines
 
 mirror around centerline
@@ -72,7 +72,7 @@ feature snap
 polyline edges
     allow polyline to be combined with other edges/curves
 
-3-d operations
+3D operations
 ---------------------
 
 rotation/transform that return a copy
@@ -86,4 +86,4 @@ primitive creation
         * wedge
 
 extrude/cut up to surface
-    allow a cut or extrude to terminate at another surface, rather than either through all or a fixed distance
+    allow a cut or extrude to terminate at another surface, rather than either through all or a fixed distance