|
55 | 55 |
|
56 | 56 | In other words, each entry ``out[i,j,...,:]`` is an N-dimensional
|
57 | 57 | value drawn from the distribution.
|
| 58 | + dtype : data type object, optional (default : float) |
| 59 | + The type and size of the data to be returned. |
58 | 60 | list of str
|
59 | 61 | This is not a real return value. It exists to test
|
60 | 62 | anonymous return values.
|
@@ -199,20 +201,25 @@ def test_other_parameters():
|
199 | 201 |
|
200 | 202 |
|
201 | 203 | def test_returns():
|
202 |
| - assert len(doc['Returns']) == 3 |
| 204 | + assert len(doc['Returns']) == 4 |
203 | 205 | arg, arg_type, desc = doc['Returns'][0]
|
204 | 206 | assert arg == 'out'
|
205 | 207 | assert arg_type == 'ndarray'
|
206 | 208 | assert desc[0].startswith('The drawn samples')
|
207 | 209 | assert desc[-1].endswith('distribution.')
|
208 |
| - |
| 210 | + |
209 | 211 | arg, arg_type, desc = doc['Returns'][1]
|
| 212 | + assert arg == 'dtype' |
| 213 | + assert arg_type == 'data type object, optional (default : float)' |
| 214 | + assert desc[0].startswith('The type and size') |
| 215 | + |
| 216 | + arg, arg_type, desc = doc['Returns'][2] |
210 | 217 | assert arg == ''
|
211 | 218 | assert arg_type == 'list of str'
|
212 | 219 | assert desc[0].startswith('This is not a real')
|
213 | 220 | assert desc[-1].endswith('anonymous return values.')
|
214 | 221 |
|
215 |
| - arg, arg_type, desc = doc['Returns'][2] |
| 222 | + arg, arg_type, desc = doc['Returns'][3] |
216 | 223 | assert arg == ''
|
217 | 224 | assert arg_type == 'no_description'
|
218 | 225 | assert not ''.join(desc).strip()
|
@@ -404,6 +411,8 @@ def test_str():
|
404 | 411 |
|
405 | 412 | In other words, each entry ``out[i,j,...,:]`` is an N-dimensional
|
406 | 413 | value drawn from the distribution.
|
| 414 | +dtype : data type object, optional (default : float) |
| 415 | + The type and size of the data to be returned. |
407 | 416 | list of str
|
408 | 417 | This is not a real return value. It exists to test
|
409 | 418 | anonymous return values.
|
@@ -570,6 +579,9 @@ def test_sphinx_str():
|
570 | 579 | In other words, each entry ``out[i,j,...,:]`` is an N-dimensional
|
571 | 580 | value drawn from the distribution.
|
572 | 581 |
|
| 582 | + **dtype** : data type object, optional (default : float) |
| 583 | + The type and size of the data to be returned. |
| 584 | +
|
573 | 585 | list of str
|
574 | 586 | This is not a real return value. It exists to test
|
575 | 587 | anonymous return values.
|
|
0 commit comments