Skip to content

Commit

Permalink
Merge pull request #73 from gumyr/main
Browse files Browse the repository at this point in the history
Doc improvements
  • Loading branch information
gumyr authored Sep 23, 2022
2 parents c767b83 + fec7ff0 commit 50f1659
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ functionality.

Examples illustrating how to use much of the functionality of this sub-package
can be found in the
`extensions_examples.py <https://github.com/gumyr/cq_warehouse/blob/main/examples/extensions_examples.py>`_
file.
`examples <https://github.com/gumyr/cq_warehouse/blob/main/examples>`_
directory.

To help the user in debugging exceptions generated by the Opencascade core, the
dreaded ``StdFail_NotDone`` exception is caught and augmented with a more
Expand All @@ -33,11 +33,11 @@ visible to the IDE which makes working with them more difficult.
The `build_cadquery_patch.py <https://github.com/gumyr/cq_warehouse/blob/main/scripts/build_cadquery_patch.py>`_
script takes the cq_warehouse extensions.py file (from your pip install) and generates a patch file
custom to the version of CadQuery that you're using (the version found with the python ``import cadquery``).
The user needs to apply the patch for the changes to take effect. Reversing the patch will restore the four changed
The user needs to apply the patch for the changes to take effect. Reversing the patch will restore the changed
files. The patch command can also generate versioned backups of the changed files if
the user wants even more security.

Currently, cq_warehouse.extensions augments these four CadQuery source files:
Currently, cq_warehouse.extensions augments these CadQuery source files:

* assembly.py,
* cq.py,
Expand Down
4 changes: 2 additions & 2 deletions docs/subclassing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ of Solid and is defined as follows:
class Nut(ABC, Solid):
and therefore inherits the methods of Solid and Shape. ``Nut`` is itself
a base class for a whole series of different classes of nuts like ``DomedCadNut``
a base class for a whole series of different classes of nuts like ``DomedCapNut``
which is defined as follows:

.. code-block:: python
Expand Down Expand Up @@ -167,4 +167,4 @@ always generated by the custom class, the ``if`` check can be eliminated.

If the desired object is a Compound (e.g. cq_warehouse bearings) the class
should sub-class Compound and initialize the base (Compound) class in the
normal way.
normal way.

0 comments on commit 50f1659

Please sign in to comment.