summaryrefslogtreecommitdiffstats
path: root/tests/roots/test-intl/docfields.txt
blob: b1b3c891519abbd457b39c85b6dc0b70b5ef6123 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
:tocdepth: 2

i18n with docfields
===================

.. single TypedField

.. class:: Cls1
   :no-index:

   :param param: description of parameter param

.. grouped TypedFields

.. class:: Cls2
   :no-index:

   :param foo: description of parameter foo
   :param bar: description of parameter bar


.. single GroupedField

.. class:: Cls3(values)
   :no-index:

   :raises ValueError: if the values are out of range

.. grouped GroupedFields

.. class:: Cls4(values)
   :no-index:

   :raises TypeError: if the values are not valid
   :raises ValueError: if the values are out of range


.. single Field

.. class:: Cls5
   :no-index:

   :returns: a new :class:`Cls3` instance

.. Field is never grouped