Skip to content

Commit

Permalink
Fix SciMath package name (#176)
Browse files Browse the repository at this point in the history
Our docs are slightly inconsistent about the package name: sometimes its
spelled as `SciMath`, sometimes as `Scimath`. As far as I can tell, the
intended spelling is `SciMath`.

This PR changes occurrences of `Scimath` to either `SciMath` or
`scimath`, depending on context.
  • Loading branch information
mdickinson authored Mar 29, 2023
1 parent 49468e0 commit 193a251
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 7 deletions.
3 changes: 1 addition & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Scimath Documentation
SciMath Documentation
===================================

The SciMath project includes packages to support scientific and mathematical
Expand All @@ -26,4 +26,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

2 changes: 1 addition & 1 deletion docs/source/units/about.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
===============================================================================
Scimath Units User Manual Copyright Notice
SciMath Units User Manual Copyright Notice
===============================================================================

:Authors: Tim Diller
Expand Down
4 changes: 2 additions & 2 deletions docs/source/units/unit_numpy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
Units with Numpy
===============================================================================

For high-performance computation, Scimath.units includes two objects for adding
units to `Numpy`_ `ndarray`_ objects: the
For high-performance computation, ``scimath.units`` includes two objects for
adding units to `Numpy`_ `ndarray`_ objects: the
:py:class:`~scimath.units.unit_scalar.UnitScalar` and the
:py:class:`~scimath.units.unit_scalar.UnitArray`. UnitScalars and UnitArrays
can be used directly in computations but are best handled with :ref:`unitted
Expand Down
3 changes: 1 addition & 2 deletions docs/source/units/user_ref.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _user-ref:

===============================================================================
Scimath Units User Reference
SciMath Units User Reference
===============================================================================

.. _internal-representation:
Expand Down Expand Up @@ -62,4 +62,3 @@ UnitScalar
UnitArray
-------------------------------------------------------------------------------
.. autofunction:: scimath.units.unit_scalar.UnitArray

0 comments on commit 193a251

Please sign in to comment.