Skip to content

Commit

Permalink
Fix example documentation typos (#1423)
Browse files Browse the repository at this point in the history
* Fix "Using Point Lists" example API reference

In the example "Using Point Lists" the `pushPoints` method is
used. That method should be referenced in the "API reference"
section instead of the `points`.

* Fix "Copying Workplanes" example markdown typo

There is a missing ":" in the "API reference" hlist that make the
section look empty

---------

Co-authored-by: Sergio Merino Alonso <[email protected]>
  • Loading branch information
sermelo and Sergio Merino Alonso authored Oct 22, 2023
1 parent f467ac9 commit 17846d6
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ like :py:meth:`Workplane.circle` and :py:meth:`Workplane.rect`, will operate on
.. hlist::
:columns: 2

* :py:meth:`Workplane.points` **!**
* :py:meth:`Workplane.pushPoints` **!**
* :py:meth:`Workplane`
* :py:meth:`Workplane.circle`
* :py:meth:`Workplane.extrude`
Expand Down Expand Up @@ -526,7 +526,7 @@ An existing CQ object can copy a workplane from another CQ object.

.. topic:: API References

.. hlist:
.. hlist::
:columns: 2

* :py:meth:`Workplane.copyWorkplane` **!**
Expand Down

0 comments on commit 17846d6

Please sign in to comment.