Skip to content

Commit 0455237

Browse files
committed
Some fixups with Sphinx warnings.
1 parent 2a9bf05 commit 0455237

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

docs/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ number of different build systems. Namely:
2727
but only if Python has been started without :py:option:`-S` (this is
2828
useful for ``scikit-build-core`` projects).
2929
- ``pyawaitable --include`` on the command line returns the path of the
30-
include directory (useful for ``meson-python`` projects).
30+
include directory (useful for ``meson-python`` projects).
3131

3232
.. note::
3333

docs/reference.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ Reference
44
General
55
-------
66

7+
.. function:: pyawaitable.include()
8+
9+
Return the include path of ``pyawaitable.h``.
10+
11+
12+
.. envvar:: PYAWAITABLE_INCLUDE
13+
14+
Result of :func:`pyawaitable.include`, stored as an environment variable
15+
through a ``.pth`` file (only available when Python isn't run through
16+
:py:option:`-S`).
17+
18+
719
.. c:function:: int PyAwaitable_Init(void)
820
921
Initialize PyAwaitable. This should typically be done in the :c:data:`Py_mod_exec`
@@ -107,11 +119,11 @@ Value Storage
107119
object.
108120
109121
This function expects ``PyObject **`` pointers passed to the ``...``.
110-
These will then be set to :term:`borrowed references`. The number of
111-
arguments passed to the ``...`` must match the sum of all *nargs* to prior
112-
:c:func:`PyAwaitable_SaveValues` calls. For example, if one call stored
113-
two values, and then another call stored three values, this function would
114-
expect five pointers to be passed.
122+
These will then be set to :term:`borrowed reference <borrowed reference>`.
123+
The number of arguments passed to the ``...`` must match the sum of all
124+
*nargs* to prior :c:func:`PyAwaitable_SaveValues` calls. For example, if
125+
one call stored two values, and then another call stored three values, this
126+
function would expect five pointers to be passed.
115127
116128
Pointers passed to the ``...`` may be ``NULL``, in which case the object at
117129
that position is skipped.

0 commit comments

Comments
 (0)