Skip to content

Commit 1937449

Browse files
committed
Added ProductDomain to api doc
1 parent 7b7eaac commit 1937449

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

doc/source/apiref/domains.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@ Class Reference
3232
.. autoclass:: Domain
3333
:members:
3434

35+
36+
:class:`ProductDomain` - Cartesian product of multiple domains
37+
--------------------------------------------------------------
38+
39+
Class Reference
40+
~~~~~~~~~~~~~~~
41+
.. autoclass:: ProductDomain
42+
:members:
43+
44+
3545
:class:`RealDomain` - (A subset of) Real Numbers
3646
------------------------------------------------
3747

@@ -58,4 +68,4 @@ This domain is used by :class:`MultinomialModel`.
5868
Class Reference
5969
~~~~~~~~~~~~~~~
6070
.. autoclass:: MultinomialDomain
61-
:members:
71+
:members:

src/qinfer/domains.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ class ProductDomain(Domain):
152152
"""
153153
A domain made from the cartesian product of other domains.
154154
155-
:param Domain domains: ``Domain`` objects as separate arguments,
156-
or as a singe list of ``Domain``s.
155+
:param Domain domains: ``Domain`` instances as separate arguments,
156+
or as a singe list of ``Domain`` instances.
157157
"""
158158
def __init__(self, *domains):
159159

@@ -268,7 +268,7 @@ def from_regular_arrays(self, arrays):
268268
corresponding to the factor domains into a single array
269269
with the dtype of the ``ProductDomain``.
270270
271-
:param list array: A list of ``np.ndarray``s
271+
:param list array: A list with each element of type ``np.ndarray``
272272
273273
:rtype: `np.ndarray`
274274
"""

0 commit comments

Comments
 (0)