From 25cfc9ecf1cdb81fec93a7bc3dbaa4422e6f1a41 Mon Sep 17 00:00:00 2001 From: Scott Barlow <31610422+Spectre5@users.noreply.github.com> Date: Fri, 10 Nov 2023 00:05:11 -0800 Subject: [PATCH] Typos --- docs/algebra_definition.rst | 14 +++++++------- docs/introductory_examples.rst | 2 +- docs/location_arithmetic.rst | 13 +++---------- docs/slide_latch.py | 2 +- docs/tips.rst | 2 +- 5 files changed, 13 insertions(+), 20 deletions(-) diff --git a/docs/algebra_definition.rst b/docs/algebra_definition.rst index 0516793..ae98eb5 100644 --- a/docs/algebra_definition.rst +++ b/docs/algebra_definition.rst @@ -12,7 +12,7 @@ Objects and arithmetic :math:`C^2` is the set of all ``Sketch`` objects ``s`` with ``s._dim = 2`` -:math:`C^1` is the set of all ``Curve`` objects ``c`` with ``c._dim = 3`` +:math:`C^1` is the set of all ``Curve`` objects ``c`` with ``c._dim = 1`` **Neutral elements:** @@ -49,7 +49,7 @@ with :math:`B^3 \subset C^3, B^2 \subset C^2` and :math:`B^1 \subset C^1` :math:`\; a \; \& \; b :=` ``a.intersect(b)`` for each operation - * :math:`\&` is not defined for :math:`n=1` in build123d + * :math:`\&` is not defined for :math:`n=1` in build123d * The following relationship holds: :math:`a \; \& \; b = (a + b) + -(a + (-b)) + -(b + (-a))` @@ -66,12 +66,12 @@ Locations, planes and location arithmentic **Set definitions:** -:math:`L := \lbrace` ``Location((x, y, z), (a, b, c))`` :math:`: x,y,z \in R \land a,b,c \in R \rbrace\;` - +:math:`L := \lbrace` ``Location((x, y, z), (a, b, c))`` :math:`: x,y,z \in R \land a,b,c \in R \rbrace\;` + with :math:`a,b,c` being angles in degrees. -:math:`P := \lbrace` ``Plane(o, x, z)`` :math:`: o,x,z ∈ R^3 \land \|x\| = \|z\| = 1\rbrace` - +:math:`P := \lbrace` ``Plane(o, x, z)`` :math:`: o,x,z ∈ R^3 \land \|x\| = \|z\| = 1\rbrace` + with ``o`` being the origin and ``x``, ``z`` the x- and z-direction of the plane. Neutral element: :math:`\; l_0 \in L`: ``Location()`` @@ -79,7 +79,7 @@ Neutral element: :math:`\; l_0 \in L`: ``Location()`` **Operations:** :math:`*: L \times L \rightarrow L` with :math:`(l_1,l_2) \mapsto l_1 * l_2` - + :math:`\; l_1 * l_2 :=` ``l1 * l2`` (multiply two locations) :math:`*: P \times L \rightarrow P` with :math:`(p,l) \mapsto p * l` diff --git a/docs/introductory_examples.rst b/docs/introductory_examples.rst index 3f7a333..3f9daff 100644 --- a/docs/introductory_examples.rst +++ b/docs/introductory_examples.rst @@ -662,7 +662,7 @@ example. * **Algebra mode** - Use the operator ``*`` to relocate the plane (post-mulitplication!). + Use the operator ``*`` to relocate the plane (post-multiplication!). .. literalinclude:: general_examples_algebra.py :start-after: [Ex. 22] diff --git a/docs/location_arithmetic.rst b/docs/location_arithmetic.rst index 251c2c9..d8b7097 100644 --- a/docs/location_arithmetic.rst +++ b/docs/location_arithmetic.rst @@ -26,7 +26,6 @@ For the following use the helper function: show_object(face, name="face") show_object(location_symbol(loc), name="location") - .. image:: assets/location-example-01.png @@ -40,7 +39,6 @@ For the following use the helper function: show_object(face, name="face") show_object(plane_symbol(plane), name="plane") - .. image:: assets/location-example-07.png @@ -53,7 +51,7 @@ Relative positioning to a plane 1. **Position an object on a plane relative to the plane** .. code-block:: python - + loc = Location((0.1, 0.2, 0.3), (10, 20, 30)) face = loc * Rectangle(1,2) @@ -65,11 +63,10 @@ Relative positioning to a plane show_object(face, name="face") show_object(location_symbol(loc), name="location") show_object(box, name="box") - .. image:: assets/location-example-02.png - The ``x``, ``y``, ``z`` components of ``Pos(0.2, 0.4, 0.1)`` are relative to the ``x``-axis, ``y``-axis or + The ``x``, ``y``, ``z`` components of ``Pos(0.2, 0.4, 0.1)`` are relative to the ``x``-axis, ``y``-axis or ``z``-axis of the underlying location ``loc``. Note: ``Plane(loc) *``, ``Plane(face.location) *`` and ``loc *`` are equivalent in this example. @@ -87,7 +84,6 @@ Relative positioning to a plane show_object(face, name="face") show_object(location_symbol(loc), name="location") show_object(box, name="box") - .. image:: assets/location-example-03.png @@ -107,7 +103,6 @@ Relative positioning to a plane show_object(face, name="face") show_object(location_symbol(loc), name="location") show_object(box, name="box") - .. image:: assets/location-example-04.png @@ -127,11 +122,10 @@ Relative positioning to a plane show_object(location_symbol(loc), name="location") show_object(box, name="box") show_object(location_symbol(loc * Rot(20, 40, 80), 0.5), options={"color":(0, 255, 255)}, name="local_location") - .. image:: assets/location-example-05.png - The box is positioned via ``Pos(0.2, 0.4, 0.1)`` relativce to the location ``loc * Rot(20, 40, 80)`` + The box is positioned via ``Pos(0.2, 0.4, 0.1)`` relative to the location ``loc * Rot(20, 40, 80)`` 4. **Position and rotate an object relative to a location** @@ -147,7 +141,6 @@ Relative positioning to a plane show_object(location_symbol(loc), name="location") show_object(box, name="box") show_object(location_symbol(loc * Pos(0.2, 0.4, 0.1), 0.5), options={"color":(0, 255, 255)}, name="local_location") - .. image:: assets/location-example-06.png diff --git a/docs/slide_latch.py b/docs/slide_latch.py index 1b70e04..c7bf296 100644 --- a/docs/slide_latch.py +++ b/docs/slide_latch.py @@ -22,7 +22,7 @@ with BuildPart() as latch: offset(amount=-2) fillet(slide_hole.vertices(), 1) extrude(amount=-68, mode=Mode.SUBTRACT) - # Slot for the hangle to slide in + # Slot for the handle to slide in with BuildSketch(latch.faces().sort_by(Axis.Z)[-1]): SlotOverall(32, 8) extrude(amount=-2, mode=Mode.SUBTRACT) diff --git a/docs/tips.rst b/docs/tips.rst index b5064d2..4bf78db 100644 --- a/docs/tips.rst +++ b/docs/tips.rst @@ -131,7 +131,7 @@ interchange objects between the two systems by transferring the ``wrapped`` obje Self Intersection ***************** -Avoid creating objects that intersect themselves - even if at a single vertex - as these topoplogies +Avoid creating objects that intersect themselves - even if at a single vertex - as these topologies will almost certainly be invalid (even if :meth:`~topology.Shape.is_valid` reports a ``True`` value). An example of where this my arise is with the thread of a screw (or any helical shape) where after one complete revolution the part may contact itself. One is likely be more successful if the part