Skip to content

Commit 5c4c396

Browse files
Doc: Fix footnote warning
1 parent c08efe2 commit 5c4c396

2 files changed

Lines changed: 17 additions & 11 deletions

File tree

docs/source/main-algorithms/core-classes/runner.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Full API
4343

4444
.. autoclass:: Runner
4545
:no-doc:
46+
:class-doc-from: init
4647
:members:
4748
:exclude-members: state
4849

src/runner.cpp

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,14 @@ This class has limited (no?) utility on its own, and you are unlikely to want to
6868
6969
.. important::
7070
71-
The classes that we claim derive from :any:`Reporter` in this documentation have all the methods of the
72-
:any:`Reporter` class but, for boring technical reasons, are not formally
73-
subclasses of :any:`Reporter`. If ``thing`` is an instance of a class
74-
derived from :any:`Reporter`, then you can use ``thing`` as if it were an
75-
instance of :any:`Reporter` but ``isinstance(thing, Reporter)`` will return
76-
``False``.
71+
The classes that we claim derive from :any:`Reporter` in this documentation
72+
have all the methods of the :any:`Reporter` class but, for boring technical
73+
reasons, are not formally subclasses of :any:`Reporter`. If ``thing`` is an
74+
instance of a class derived from :any:`Reporter`, then you can use ``thing``
75+
as if it were an instance of :any:`Reporter` but
76+
``isinstance(thing, Reporter)`` will return ``False``.
77+
78+
.. rubric:: Footnotes
7779
7880
.. [#sortof] Sort of, please see the note above.
7981
)pbdoc");
@@ -273,11 +275,14 @@ This class inherits from :any:`Reporter`.
273275
274276
.. important::
275277
276-
The classes derived from :any:`Runner` have all the methods of the
277-
:any:`Runner` class but, for boring technical reasons, are not formally
278-
subclasses of :any:`Runner`. If ``thing`` is an instance of a class derived
279-
from :any:`Runner`, then you can use ``thing`` as if it were an instance of
280-
:any:`Runner` but ``isinstance(thing, Runner)`` will return ``False``.
278+
The classes that we claim derive from :any:`Runner` in this documentation
279+
have all the methods of the :any:`Runner` class but, for boring technical
280+
reasons, are not formally subclasses of :any:`Runner`. If ``thing`` is an
281+
instance of a class derived from :any:`Runner`, then you can use ``thing``
282+
as if it were an instance of :any:`Runner` but ``isinstance(thing, Runner)``
283+
will return ``False``.
284+
285+
.. rubric:: Footnotes
281286
282287
.. [#sortof] Sort of, please see the note above.
283288
)pbdoc");

0 commit comments

Comments
 (0)