Merge pull request #863 from martinbudden/spelling_corrections

Fix spelling mistakes and typos.

Author: jmwright

cadquery/assembly.py

@@ -357,7 +357,7 @@ def _subloc(self, name: str) -> Tuple[Location, str]:
         """
         Calculate relative location of an object in a subassembly.
 
-        Returns the relative posiitons as well as the name of the top assembly.
+        Returns the relative positions as well as the name of the top assembly.
         """
 
         rv = Location()

cadquery/cq.py

@@ -305,7 +305,7 @@ def split(self: T, *args, **kwargs) -> T:
             )
             rv = [solid.split(*tools)]
 
-        # split using the current wokrplane
+        # split using the current workplane
         else:
 
             # boilerplate for arg/kwarg parsing
@@ -1821,7 +1821,7 @@ def spline(
             scalar parameter.)
 
             If periodic == True, then len(parameters) must be
-            len(intepolation points) + 1, otherwise len(parameters) must be equal to
+            len(interpolation points) + 1, otherwise len(parameters) must be equal to
             len(interpolation points).
         :param scale: whether to scale the specified tangent vectors before
             interpolating.
@@ -2813,7 +2813,7 @@ def cboreHole(
         # first make the hole
         hole = Solid.makeCylinder(
             diameter / 2.0, depth, center, boreDir
-        )  # local coordianates!
+        )  # local coordinates!
 
         # add the counter bore
         cbore = Solid.makeCylinder(cboreDiameter / 2.0, cboreDepth, Vector(), boreDir)
@@ -3463,7 +3463,7 @@ def _extrude(
         eDir = self.plane.zDir.multiply(distance)
 
         # one would think that fusing faces into a compound and then extruding would work,
-        # but it doesnt-- the resulting compound appears to look right, ( right number of faces, etc)
+        # but it doesn't-- the resulting compound appears to look right, ( right number of faces, etc)
         # but then cutting it from the main solid fails with BRep_NotDone.
         # the work around is to extrude each and then join the resulting solids, which seems to work
 
@@ -3597,7 +3597,7 @@ def interpPlate(
         :param surf_pts = [] (uses only edges if [])
         :type surf_pts: list of [x,y,z] float coordinates
         :param thickness = 0 (returns 2D surface if 0)
-        :type thickness: float (may be negative or positive depending on thicknening direction)
+        :type thickness: float (may be negative or positive depending on thickening direction)
         :param combine: should the results be combined with other solids on the stack
             (and each other)?
         :type combine: true to combine shapes, false otherwise.
@@ -3608,8 +3608,8 @@ def interpPlate(
         :type: NbPtsOnCur Integer >= 15
         :param NbIter = 2 (OCCT default)
         :type: NbIterInteger >= 2
-        :param Anisotropie = False (OCCT default)
-        :type Anisotropie: Boolean
+        :param anisotropy = False (OCCT default)
+        :type anisotropy: Boolean
         :param: Tol2d = 0.00001 (OCCT default)
         :type Tol2d: float > 0
         :param Tol3d = 0.0001 (OCCT default)

cadquery/cqgi.py

@@ -153,7 +153,7 @@ def __init__(self):
 class BuildResult(object):
     """
     The result of executing a CadQuery script.
-    The success property contains whether the exeuction was successful.
+    The success property contains whether the execution was successful.
 
     If successful, the results property contains a list of all results,
     and the first_result property contains the first result.

doc/classreference.rst

@@ -4,7 +4,7 @@
 CadQuery Class Summary
 *************************
 
-This page documents all of the methods and functions of the CadQuery classes, organized alphabatically.
+This page documents all of the methods and functions of the CadQuery classes, organized alphabetically.
 
 .. seealso::
 

doc/examples.rst

@@ -59,7 +59,7 @@ Plate with Hole
 A rectangular box, but with a hole added.
 
 "\>Z" selects the top most face of the resulting box. The hole is located in the center because the default origin
-of a working plane is the projected origin of the last Workplane, the last Worplane having origin at (0,0,0) the 
+of a working plane is the projected origin of the last Workplane, the last Workplane having origin at (0,0,0) the 
 projection is at the center of the face. The default hole depth is through the entire part.
 
 

doc/primer.rst

@@ -295,7 +295,7 @@ Which produces the output:
 The first thing to note is that this is a different :class:`~cadquery.Workplane` object to the
 previous one, and in the :attr:`~cadquery.Workplane.parent` attribute of this
 :class:`~cadquery.Workplane` is our previous :class:`~cadquery.Workplane`. Returning a new instance
-of :class:`~caduqery.Workplane` is the normal behaviour of most :class:`~cadquery.Workplane` methods
+of :class:`~cadquery.Workplane` is the normal behaviour of most :class:`~cadquery.Workplane` methods
 (with some exceptions, as will be shown below) and this is how the `chaining`_ concept is
 implemented.
 

tests/test_cadquery.py

@@ -55,15 +55,15 @@
 """
 
 # clean up any summary file that is in the output directory.
-# i know, this sux, but there is no other way to do this in 2.6, as we cannot do class fixutres till 2.7
+# i know, this sux, but there is no other way to do this in 2.6, as we cannot do class fixtures till 2.7
 writeStringToFile(SUMMARY_TEMPLATE, SUMMARY_FILE)
 
 
 class TestCadQuery(BaseTest):
     def tearDown(self):
         """
         Update summary with data from this test.
-        This is a really hackey way of doing it-- we get a startup event from module load,
+        This is a really hacky way of doing it-- we get a startup event from module load,
         but there is no way in unittest to get a single shutdown event-- except for stuff in 2.7 and above
 
         So what we do here is to read the existing file, stick in more content, and leave it
@@ -187,7 +187,7 @@ def testPolygonPlugin(self):
         """
         Tests a plugin to make regular polygons around points on the stack
 
-        Demonstratings using eachpoint to allow working in local coordinates
+        Demonstrations using eachpoint to allow working in local coordinates
         to create geometry
         """
 
@@ -716,7 +716,7 @@ def testSplineSpecifyingParameters(self):
             .consolidateWires()
         )
 
-        # Test point equivalence for parameter, and pamater multiplied by 10:
+        # Test point equivalence for parameter, and parameter multiplied by 10:
         test_point1 = spline1.edges().val().positionAt(1.5, mode="parameter")
         test_point2 = spline2.edges().val().positionAt(15, mode="parameter")
         expected_test_point = Vector(1.625, 0.625, 0.0)
@@ -880,7 +880,7 @@ def ellipsePoints(r1, r2, a):
         start = ellipseArc3.vertices().objects[0]
         end = ellipseArc3.vertices().objects[1]
 
-        # swap start and end points for coparison due to different sense
+        # swap start and end points for comparison due to different sense
         self.assertTupleAlmostEquals(
             (start.X, start.Y), (p0[0] + ex_rot, p0[1] + ey_rot), 3
         )
@@ -909,7 +909,7 @@ def ellipsePoints(r1, r2, a):
         start = ellipseArc4.vertices().objects[0]
         end = ellipseArc4.vertices().objects[1]
 
-        # swap start and end points for coparison due to different sense
+        # swap start and end points for comparison due to different sense
         self.assertTupleAlmostEquals(
             (start.X, start.Y), (p0[0] + ex_rot - ex_rot, p0[1] + ey_rot - ey_rot), 3
         )
@@ -1486,7 +1486,7 @@ def testSolidReferenceCombineFalse(self):
         # result has 6 faces, because it was not combined with the original
         self.assertEqual(6, t.faces().size())
         self.assertEqual(6, r.faces().size())  # original is unmodified as well
-        # subseuent operations use that context solid afterwards
+        # subsequent operations use that context solid afterwards
 
     def testSimpleWorkplane(self):
         """
@@ -1794,7 +1794,7 @@ def testWorkplaneCenterMove(self):
         self.saveModel(t)
 
     def testBasicLines(self):
-        "Make a triangluar boss"
+        "Make a triangular boss"
         global OUTDIR
         s = Workplane(Plane.XY())
 
@@ -2990,7 +2990,7 @@ def testEnclosure(self):
 
         # How far in from the edges the screwposts should be place.
         p_screwpostInset = 12.0
-        # nner Diameter of the screwpost holes, should be roughly screw diameter not including threads
+        # Inner Diameter of the screwpost holes, should be roughly screw diameter not including threads
         p_screwpostID = 4.0
         # Outer Diameter of the screwposts.\nDetermines overall thickness of the posts
         p_screwpostOD = 10.0
@@ -3682,7 +3682,7 @@ def testCopyWorkplane(self):
     def testWorkplaneFromTagged(self):
 
         # create a flat, wide base. Extrude one object 4 units high, another
-        # object ontop of it 6 units high. Go back to base plane. Extrude an
+        # object on top of it 6 units high. Go back to base plane. Extrude an
         # object 11 units high. Assert that top face is 11 units high.
         result = (
             Workplane("XY")
@@ -3763,7 +3763,7 @@ def testTagSelectors(self):
 
     def test_interpPlate(self):
         """
-        Tests the interpPlate() functionnalites
+        Tests the interpPlate() functionalities
         Numerical values of Areas and Volumes were obtained with the Area() and Volume() functions on a Linux machine under Debian 10 with python 3.7.
         """