Skip to content

Commit b8277cd

Browse files
committed
doc: nitpick fixes; hints at sphinx.testing
1 parent e7f55d3 commit b8277cd

File tree

4 files changed

+14
-3
lines changed

4 files changed

+14
-3
lines changed

docs/source/arch.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Architecture
7272
There are 2 ways to feed the `solution` back into the same `pipeline`:
7373

7474
* by reusing the pre-compiled `plan` (coarse-grained), or
75-
* by using the ``compute(recalculate_from=...)`` argument (fine-grained),
75+
* by using the ``compute(recompute_from=...)`` argument (fine-grained),
7676

7777
as described in :ref:`recompute` tutorial section.
7878

graphtik/jetsam.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Copyright 2019-2020, Kostis Anagnostopoulos;
22
# Licensed under the terms of the Apache License, Version 2.0. See the LICENSE file associated with the project for terms.
3-
""":term:`jetsam` utility for annotating exceptions from ``locals()``.
3+
""":term:`jetsam` utility for annotating exceptions from ``locals()`` like :pep:`678`
4+
5+
PY3.11 exception-notes.
46
57
.. doctest::
68
:hide:

graphtik/modifier.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1138,7 +1138,7 @@ def sfxed(
11381138
of the function.
11391139
:param sfx0:
11401140
the 1st (arbitrary object) sideffect marked as "acting" on the `dependency`.
1141-
:param sfx0:
1141+
:param sfx_list:
11421142
more (arbitrary object) sideffects (like the `sfx0`)
11431143
:param keyword:
11441144
the name for the function argument it corresponds.

test/sphinxext/test_directive.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
"""
2+
Pytest-ing sphinx directives is `yet undocumented
3+
<https://github.com/sphinx-doc/sphinx/issues/7008>`_
4+
and as explained also in `this sourceforge <>`_ thread,
5+
you may learn more from the `test-cases in the *sphinx* sources
6+
<https://github.com/sphinx-doc/sphinx/blob/master/tests/test_ext_doctest.py>`_
7+
or `similar projects
8+
<https://github.com/pauleveritt/customizing_sphinx/blob/master/tests/integration/test_directive.py>`_.
9+
"""
110
import os.path as osp
211
import re
312
import xml.etree

0 commit comments

Comments
 (0)