diff --git a/doc/index.rst b/doc/index.rst index 706b9f88253005b2e2f5b4a327eef57e0d0ec74d..ebbe469762a257bd0f5c4cf038a2d00b99bc5dd2 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,6 +3,7 @@ Welcome to pymbolic! .. automodule:: pymbolic + Pymbolic around the web ----------------------- diff --git a/pymbolic/__init__.py b/pymbolic/__init__.py index 636203deab366b5b4b1695e97eb28a982b7301b7..d0e2ca0dadc97bf86fa747890a72d684c1bab5bb 100644 --- a/pymbolic/__init__.py +++ b/pymbolic/__init__.py @@ -55,7 +55,7 @@ Next, let's create an expression using *x*: (x + 1)**5 Note the two ways an expression can be printed, namely :func:`repr` and -:func:`str`. :mod:`pymbolic` purposefully distinguishes the two. +:class:`str`. :mod:`pymbolic` purposefully distinguishes the two. :mod:`pymbolic` does not perform any manipulations on expressions you put in. It has a few of those built in, but that's not really the point: diff --git a/pymbolic/geometric_algebra/__init__.py b/pymbolic/geometric_algebra/__init__.py index e8da55cfd138f6941fcfaa9c85b476021f300575..ddd4db7bf8e65ff523c59f769975f5cd3ead2453 100644 --- a/pymbolic/geometric_algebra/__init__.py +++ b/pymbolic/geometric_algebra/__init__.py @@ -420,9 +420,9 @@ class MultiVector(object): Unified Language for Mathematics and Physics <https://books.google.com?isbn=9027725616>`_. Springer, 1987. - The object behaves much like the corresponding - :class:`sympy.galgebra.GA.MV` object in :mod:`sympy`, especially with - respect to the supported operators: + The object behaves much like the corresponding :class:`galgebra.mv.Mv` + object in :mod:`galgebra`, especially with respect to the supported + operators: =================== ======================================================== Operation Result diff --git a/pymbolic/mapper/collector.py b/pymbolic/mapper/collector.py index 620e2e65fc070723fb74cb6b28543eaad9018e22..81d4eb62a5a841e5276c784b369ef50b7c23e07c 100644 --- a/pymbolic/mapper/collector.py +++ b/pymbolic/mapper/collector.py @@ -32,7 +32,7 @@ class TermCollector(IdentityMapper): """A term collector that assumes that multiplication is commutative. Allows specifying *parameters* (a set of - :class:`pymbolic.primitive.Variable` instances) that are viewed as being + :class:`pymbolic.primitives.Variable` instances) that are viewed as being coefficients and are not used for term collection. """ diff --git a/pymbolic/mapper/stringifier.py b/pymbolic/mapper/stringifier.py index e0181e9bd9e2ebec7a4a90704ff1377c37a473c6..2d8bad5969a0827ca272f356640b06c0bb292ce1 100644 --- a/pymbolic/mapper/stringifier.py +++ b/pymbolic/mapper/stringifier.py @@ -83,7 +83,7 @@ class StringifyMapper(pymbolic.mapper.Mapper): this mapper. When it encounters an unsupported :class:`pymbolic.primitives.Expression` - subclass, it calls its :meth:`pymbolic.primitives.Expression.stringifier` + subclass, it calls its :meth:`pymbolic.primitives.Expression.make_stringifier` method to get a :class:`StringifyMapper` that potentially does. """ diff --git a/pymbolic/primitives.py b/pymbolic/primitives.py index 82abfe2b7c666e0a5290d9815195fc2981bf9f2f..fe30ca1a4312a828dc8b3b827dc75f72e028252f 100644 --- a/pymbolic/primitives.py +++ b/pymbolic/primitives.py @@ -155,7 +155,7 @@ Helper functions Interaction with :mod:`numpy` arrays ------------------------------------ -:mod:`numpy.ndarray` instances are supported anywhere in an expression. +:class:`numpy.ndarray` instances are supported anywhere in an expression. In particular, :mod:`numpy` object arrays are useful for capturing vectors and matrices of :mod:`pymbolic` objects. @@ -191,15 +191,17 @@ class Expression(object): .. method:: __getitem__ + .. method:: __getinitargs__ + .. automethod:: make_stringifier .. automethod:: __eq__ + .. automethod:: is_equal .. automethod:: __hash__ + .. automethod:: get_hash .. automethod:: __str__ .. automethod:: __repr__ - .. automethod:: __repr__ - .. rubric:: Logical operator constructors .. automethod:: not_ @@ -477,7 +479,7 @@ class Expression(object): return stringifier_class_getter()(*stringify_mapper_args) def __str__(self): - """Use the :meth:`stringifier` to return a human-readable + """Use the :meth:`make_stringifier` to return a human-readable string representation of *self*. """