Skip to content

Commit 9363100

Browse files
committed
Add newly defined exceptions to the API reference in documentation [ci skip]
1 parent a7fe11d commit 9363100

File tree

2 files changed

+62
-0
lines changed

2 files changed

+62
-0
lines changed

docs/api/exceptions.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Xref
2+
====
3+
4+
.. currentmodule:: fastobo.exceptions
5+
.. automodule:: fastobo.exceptions
6+
7+
8+
Cardinality Errors
9+
------------------
10+
11+
MissingClauseError
12+
^^^^^^^^^^^^^^^^^^
13+
14+
.. autoexception:: MissingClauseError
15+
16+
17+
DuplicateClausesError
18+
^^^^^^^^^^^^^^^^^^^^^
19+
20+
.. autoexception:: DuplicateClausesError
21+
22+
23+
SingleClauseError
24+
^^^^^^^^^^^^^^^^^^
25+
26+
.. autoexception:: SingleClauseError
27+
28+
29+
Threading Errors
30+
----------------
31+
32+
DisconnectedChannelError
33+
^^^^^^^^^^^^^^^^^^^^^^^^
34+
35+
.. autoexception:: DisconnectedChannelError

docs/api/index.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Library Reference
1515
pv
1616
syn
1717
xref
18+
exceptions
1819

1920

2021
.. currentmodule:: fastobo
@@ -264,3 +265,29 @@ Xref (`fastobo.xref`)
264265

265266
fastobo.xref.Xref
266267
fastobo.xref.XrefList
268+
269+
270+
271+
Exceptions
272+
----------
273+
274+
Cardinality Errors
275+
^^^^^^^^^^^^^^^^^^
276+
277+
.. currentmodule:: fastobo.exceptions
278+
.. autosummary::
279+
:nosignatures:
280+
281+
fastobo.exceptions.MissingClauseError
282+
fastobo.exceptions.DuplicateClausesError
283+
fastobo.exceptions.SingleClauseError
284+
285+
286+
Threading Errors
287+
^^^^^^^^^^^^^^^^^^
288+
289+
.. currentmodule:: fastobo.exceptions
290+
.. autosummary::
291+
:nosignatures:
292+
293+
fastobo.exceptions.DisconnectedChannelError

0 commit comments

Comments
 (0)