lanl · bwohlberg · Oct 26, 2021 · Oct 25, 2021 · Oct 25, 2021 · Oct 25, 2021
diff --git a/docs/source/important_classes.rst → docs/source/classes.rst b/docs/source/important_classes.rst → docs/source/classes.rst
@@ -4,5 +4,5 @@ Important Classes
 .. toctree::
    :maxdepth: 1
 
-   op_linop
+   operator
    functional
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -168,7 +168,7 @@ def patched_parse(self):
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["tmp", "*.tmp.*", "*.tmp"]
+exclude_patterns = ["tmp", "*.tmp.*", "*.tmp", "index.ipynb"]
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = False

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,7 +8,7 @@ SCICO Documentation
    overview
    team
    install
-   important_classes
+   classes
    notes
    examples
    API Reference <_autosummary/scico.rst>

diff --git a/docs/source/op_linop.rst → docs/source/operator.rst b/docs/source/op_linop.rst → docs/source/operator.rst
@@ -1,9 +1,6 @@
 Operators
 =========
 
-.. todo::
-  * Document :func:`._wrap_mul_div_scalar`, :func:`._wrap_sum`
-
 An operator is a map from :math:`\mathbb{R}^n` or :math:`\mathbb{C}^n`
 to :math:`\mathbb{R}^m` or :math:`\mathbb{C}^m`.
 In SCICO, operators are primarily used to represent imaging systems

diff --git a/docs/source/overview.rst b/docs/source/overview.rst
@@ -68,14 +68,14 @@ SCICO is designed to solve problems of the form
 
 .. math::
 
-   \argmin_{\mb{x}} \; f(\mb{x}) + \sum_{r=1}^R g_r(C_r (\mb{x})),
+   \argmin_{\mb{x}} \; f(\mb{x}) + \sum_{k=1}^K g_k(C_k (\mb{x})),
 
 with :math:`\mb{x} \in \mathbb{R}^{n}` representing the reconstruction,
 e.g., a 1D, 2D, 3D, or 3D+time image,
-:math:`C_r: \mathbb{R}^{n} \to \mathbb{R}^{m_r}`
+:math:`C_k: \mathbb{R}^{n} \to \mathbb{R}^{m_k}`
 being regularization operators,
 and :math:`f: \mathbb{R}^{n} \to \mathbb{R}`
-and :math:`g_r: \mathbb{R}^{m_r} \to \mathbb{R}`
+and :math:`g_k: \mathbb{R}^{m_k} \to \mathbb{R}`
 being functionals associated with the data fidelity
 and regularization, respectively.
 

diff --git a/docs/source/style.rst b/docs/source/style.rst
@@ -29,10 +29,6 @@ We aim to incorporate `PEP 526 <https://www.python.org/dev/peps/pep-0484/>`_ typ
 
 Our coding conventions are based on both the `numpy conventions <https://numpydoc.readthedocs.io/en/latest/format.html#overview>`_ and the `google docstring conventions <https://google.github.io/styleguide/pyguide.html>`_.
 
-.. todo::
-
-   Briefly explain which components are taken from each convention (see above) to avoid ambiguity in cases in which they differ.
-
 Unicode variable names are allowed for internal usage (e.g. for Greek characters for mathematical symbols), but not as part of the public interface for functions or methods.