Skip to content

Commit 94d8c00

Browse files
committed
Finally fixed all the docs bugs
1 parent 2a3e22f commit 94d8c00

File tree

6 files changed

+26
-16
lines changed

6 files changed

+26
-16
lines changed

docs/source/api/pyx.cosmology.rst

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ pyx.cosmology
33

44
.. automodule:: pyx.cosmology
55
:members:
6+
:private-members:

docs/source/index.rst

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Welcome to pyx's documentation!
1414
:maxdepth: 2
1515
:caption: API Documentation
1616

17-
api/pyx
1817
api/pyx.cosmology
1918
api/pyx.io
2019
api/pyx.maths

pyx/io.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
__all__ = [
99
'dict_to_hdf5_attributes',
10-
'dict_to_hdf5_group'
10+
'dict_to_hdf5_group',
1111
'load_yaml',
1212
'write_row',
1313
]
@@ -111,8 +111,6 @@ def write_row(output, data, col_width=16, decimals=4):
111111
The data that will be written to output. Each item will be
112112
written to a new column of the output.
113113
114-
Optional
115-
--------
116114
col_width: int, optional
117115
The width of the columns in number of characters.
118116
Default: 16

pyx/maths.py

+14-11
Original file line numberDiff line numberDiff line change
@@ -237,17 +237,20 @@ def moving_mean(x, w, mode='full'):
237237
The width of the window.
238238
239239
mode: {'full', 'valid', 'same'}, optional
240-
'full': By default, mode is 'full'. This returns the moving
241-
average at each point of overlap, with an output shape
242-
of (N+M-1,). At the end-points of the convolution, the
243-
window and dataset do not overlap completely, and
244-
boundary effects may be seen.
245-
'same': Mode 'same' returns output of length max(M, N).
246-
Boundary effects are still visible.
247-
'valid': Mode 'valid' returns output of length
248-
max(M, N) - min(M, N) + 1. The moving average is only
249-
given for points where the window and data overlap
250-
completely.
240+
'full':
241+
By default, mode is 'full'. This returns the moving
242+
average at each point of overlap, with an output shape
243+
of (N+M-1,). At the end-points of the convolution, the
244+
window and dataset do not overlap completely, and
245+
boundary effects may be seen.
246+
'same':
247+
Mode 'same' returns output of length max(M, N).
248+
Boundary effects are still visible.
249+
'valid':
250+
Mode 'valid' returns output of length
251+
max(M, N) - min(M, N) + 1. The moving average is only
252+
given for points where the window and data overlap
253+
completely.
251254
252255
Returns
253256
-------

pyx/plots.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def make_lookback_time_axis(ax, cosmo='Planck18', z_range=None, major_tick_spaci
6969
>>> ax.set_xlim(min(x), max(x))
7070
>>> ax2 = pyxplots.make_lookback_time_axis(ax)
7171
>>> ax.set_xlabel('Redshift')
72-
>>> ax2.set_xlabel('comoving distance (Gyr)')
72+
>>> ax2.set_xlabel('Lookback Time (Gyr)')
7373
7474
"""
7575
ax2 = ax.twiny()

pyx/sampling.py

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
"""
2+
SAMPLING
3+
--------
4+
A collection of various functions and classes for performing different types
5+
of sampling.
6+
7+
"""
8+
9+
110

211
__all__ = [
312
'bootstrap_resample',

0 commit comments

Comments
 (0)