Skip to content

Commit

Permalink
chore: use anonymous reference to suppress duplicate warning
Browse files Browse the repository at this point in the history
  • Loading branch information
cako committed Dec 24, 2022
1 parent 3d07263 commit e0f7d3a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/addingsolver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ After that we define our new object:
class CG(Solver):
followed by a `numpydoc docstring <https://numpydoc.readthedocs.io/en/latest/format.html/>`_
followed by a `numpydoc docstring <https://numpydoc.readthedocs.io/en/latest/format.html/>`__
(starting with ``r"""`` and ending with ``"""``) containing the documentation of the solver. Such docstring should
contain at least a short description of the solver, a ``Parameters`` section with a description of the
input parameters of the associated ``_init__`` method and a ``Notes`` section providing a reference to the original
Expand Down Expand Up @@ -239,7 +239,7 @@ adheres to the guidelines of PyLops:

- the new class contains at least ``__init__``, ``setup``, ``step``, ``run``, ``finalize``, and ``solve`` methods.

- each of the above methods have a `numpydoc docstring <https://numpydoc.readthedocs.io/>`_ documenting
- each of the above methods have a `numpydoc docstring <https://numpydoc.readthedocs.io/>`__ documenting
at least the input ``Parameters`` and the ``__init__`` method contains also a ``Notes`` section providing a
mathematical explanation of the solver.

Expand Down

0 comments on commit e0f7d3a

Please sign in to comment.