From 89c70cda0103ed9c7d9764e7934871dd82817a3e Mon Sep 17 00:00:00 2001
From: Kaushik Kulkarni <kaushikcfd@gmail.com>
Date: Wed, 26 Aug 2020 18:25:34 -0500
Subject: [PATCH] fixes docs references
---
doc/index.rst | 1 +
pymbolic/__init__.py | 2 +-
pymbolic/geometric_algebra/__init__.py | 6 +++---
pymbolic/mapper/collector.py | 2 +-
pymbolic/mapper/stringifier.py | 2 +-
pymbolic/primitives.py | 10 ++++++----
6 files changed, 13 insertions(+), 10 deletions(-)
diff --git a/doc/index.rst b/doc/index.rst
index 706b9f8..ebbe469 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 636203d..d0e2ca0 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 e8da55c..ddd4db7 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 620e2e6..81d4eb6 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 e0181e9..2d8bad5 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 82abfe2..fe30ca1 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*.
"""
--
GitLab