Skip to content

Commit f67a130

Browse files
committedNov 5, 2022
Tweak some docs language
1 parent 67cf1a2 commit f67a130

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed
 

‎doc/source/index.rst

+6-4
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ and package managers, including:
6363

6464
* OpenEuler: ``python-sphobjinv``
6565

66-
* openSUSE: ``python-sphobjinv`` (`info <https://build.opensuse.org/package/show/openSUSE:Leap:15.2:Update/python-sphobjinv>`__)
66+
* openSUSE: ``python-sphobjinv`` (`info <https://build.opensuse.org/package/show/openSUSE:Factory/python-sphobjinv>`__)
6767

6868
* Parabola: ``python-sphobjinv`` (`info <https://www.parabola.nu/packages/?q=python-sphobjinv>`__)
6969

@@ -103,9 +103,11 @@ The project source repository is on GitHub: `bskinn/sphobjinv
103103
Indices and Tables
104104
------------------
105105

106-
* :ref:`genindex`
107-
* :ref:`modindex`
108-
* :ref:`search`
106+
* :ref:`genindex`
107+
108+
* :ref:`modindex`
109+
110+
* :ref:`search`
109111

110112

111113
.. raw:: html

‎doc/source/syntax.rst

+10-6
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,16 @@ Based upon a quick ``git diff`` of the `Sphinx repository
1313
<https://github.com/sphinx-doc/sphinx>`__, it is thought to be valid for all
1414
Sphinx versions >=1.0b1 that make use of this "version 2" |objects.inv| format.
1515

16-
**NOTE** that the previous version of the syntax presented here has been
17-
shown to be inaccurate (see :issue:`181`), in that it *is*
18-
permitted for the |{name}|_ field to contain whitespace.
19-
The descriptions below have been updated to reflect this and to provide
20-
more detailed information on the constraints governing each field
21-
of an |objects.inv| data line.
16+
**NOTE** that previous versions of the syntax presented here have been
17+
shown to be inaccurate:
18+
19+
* It *is* permitted for the |{name}|_ field to contain whitespace (see :issue:`181`).
20+
21+
* It *is* permitted for the |{role}|_ field to contain a colon (see :issue:`256`).
22+
23+
The descriptions below have been updated to reflect this and to provide more
24+
detailed information on the constraints governing each field of an |objects.inv|
25+
data line.
2226

2327
----
2428

0 commit comments

Comments
 (0)
Please sign in to comment.