Skip to content

Commit 5a8acf1

Browse files
authored
DOC: Fix 3rd level headings in .rst file (#23)
In one of the docs I used ### for the third level of headings in and rst and that doesn't work, replacing with ^ underscored heading renders correctly.
1 parent 82466a5 commit 5a8acf1

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

docs/source/api/for_backends.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,13 @@ decorator is used (see next section).
3131

3232
Some of the most important things are:
3333

34-
### ``name``
34+
``name``
35+
^^^^^^^^
3536

3637
The name of the backend, must match the name of the entry-point.
3738

38-
### ``primary_types`` and ``secondary_types``
39+
``primary_types`` and ``secondary_types``
40+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3941

4042
Primary and secondary types are defined by a sequence of strings
4143
and stored as ``primary_types`` and ``secondary_types`` attributes in
@@ -61,7 +63,8 @@ If you use an abstract base class, note that you must take a lot of care:
6163
classes correctly (but we order them last if a primary type, which is typically right).
6264
- ``spatch`` will not guarantee correct behavior if an ABC is mutated at runtime.
6365

64-
### ``requires_opt_in``
66+
``requires_opt_in``
67+
^^^^^^^^^^^^^^^^^^^
6568

6669
A boolean indicating whether your backend should be active by default.
6770
Typically, set this to ``True`` for a type dispatching backend and ``False`` otherwise.
@@ -86,7 +89,8 @@ set this to ``True`` if it's behavior matches the library behavior closely.
8689
or only allow specific ones, and then everyone loses...
8790

8891

89-
### functions
92+
functions
93+
^^^^^^^^^
9094

9195
A mapping of library functions to your implementations. All fields use
9296
the ``__module__:__qualname__`` identifiers to avoid immediate import.
@@ -103,7 +107,8 @@ The following fields are supported for each function:
103107

104108
``spatch`` provides tooling to help create this mapping.
105109

106-
### Manual backend prioritization
110+
Manual backend prioritization
111+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
107112

108113
``spatch`` tries to order backends based on the types,
109114
but this cannot get the order right always.
@@ -114,7 +119,8 @@ for example ``higher_priority_than = ["default"]`` or
114119
It is your responsibility to ensure that these prioritizations make sense and
115120
are acceptable to other backends.
116121

117-
### More?
122+
More?
123+
^^^^^
118124

119125
.. note:: Missing information?
120126
We are probably missing important information currently. For example,

0 commit comments

Comments
 (0)