Use asterisk footnotes for numpydoc

See numpy/numpydoc#130
peterjc · Oct 25, 2017 · a06a65c · a06a65c
1 parent a8d3e30
commit a06a65c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/Bio/SearchIO/BlastIO/__init__.py b/Bio/SearchIO/BlastIO/__init__.py
@@ -57,7 +57,7 @@
 |                +-------------------------+-----------------------------+
 |                | reference               | BlastOutput_reference       |
 |                +-------------------------+-----------------------------+
-|                | version                 | BlastOutput_version [1]_    |
+|                | version                 | BlastOutput_version [*]_    |
 |                +-------------------------+-----------------------------+
 |                | description             | Iteration_query-def         |
 |                +-------------------------+-----------------------------+
@@ -275,7 +275,7 @@
 |             +-------------------+--------------+
 |             | bitscore_raw      | score        |
 +-------------+-------------------+--------------+
-| HSPFragment | frames            | frames [2]_  |
+| HSPFragment | frames            | frames [*]_  |
 | (also via   +-------------------+--------------+
 | HSP)        | aln_span          | length       |
 |             +-------------------+--------------+
@@ -399,9 +399,9 @@
 +-----------------+-------------------------+----------------------------------+
 
 
-.. [1] may be modified
+.. [*] may be modified
 
-.. [2] When 'frames' is present, both ``query_frame`` and ``hit_frame`` will be
+.. [*] When 'frames' is present, both ``query_frame`` and ``hit_frame`` will be
    present as well. It is recommended that you use these instead of 'frames' directly.
 
 """

diff --git a/Bio/SearchIO/BlatIO.py b/Bio/SearchIO/BlatIO.py
@@ -137,7 +137,7 @@
 |                | query_start_all         | qStarts, start coordinate of each |
 |                |                         | query fragment                    |
 |                +-------------------------+-----------------------------------+
-|                | len [1]_                | block count, the number of blocks |
+|                | len [*]_                | block count, the number of blocks |
 |                |                         | in the alignment                  |
 +----------------+-------------------------+-----------------------------------+
 | HSPFragment    | hit                     | hit sequence, if present          |
@@ -175,7 +175,7 @@
 HSP and HSPFragment documentation for more details on these properties.
 
 
-.. [1] You can obtain the number of blocks / fragments in the HSP by invoking
+.. [*] You can obtain the number of blocks / fragments in the HSP by invoking
    ``len`` on the HSP
 
 """