Skip to content

Commit 23b4c1b

Browse files
committed
Docs: Minor docstring fixes
Sphinx 1.5 is clearly better at catching syntax errors
1 parent 99bd162 commit 23b4c1b

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

src/fastimgproto/gridder/gridder.py

+5-8
Original file line numberDiff line numberDiff line change
@@ -171,12 +171,10 @@ def calculate_oversampled_kernel_indices(subpixel_coord, oversampling):
171171
dtype: float, shape: `(n_vis, 2)`.
172172
oversampling (int): How many oversampled pixels to one regular pixel.
173173
Returns:
174-
oversampled_kernel_idx (numpy.ndarray): Corresponding oversampled pixel
175-
indexes. These are in oversampled pixel widths from the kernel
176-
centre pixel, to a maximum of half a regular pixel, so they have
177-
integer values ranging from
178-
``-oversampling/2`` to ``oversampling/2``.
179-
dtype: int, shape: `(n_vis, 2)`.
174+
numpy.ndarray: Corresponding oversampled pixel indexes. These are in oversampled pixel
175+
widths from the kernel centre pixel, to a maximum of half a regular
176+
pixel, so they have integer values ranging from ``-oversampling/2`` to
177+
``oversampling/2``. [Dtype: ``int``, shape: ``(n_vis, 2)``].
180178
"""
181179
subpixel_coord = np.atleast_1d(subpixel_coord)
182180
assert (-0.5 <= subpixel_coord).all()
@@ -207,8 +205,7 @@ def populate_kernel_cache(kernel_func, support, oversampling):
207205
cache_size = ((oversampling // 2 * 2) + 1)**2
208206
209207
Returns:
210-
cache (dict): Dictionary mapping oversampling-pixel offsets to
211-
normalised kernels.
208+
dict: Dictionary mapping oversampling-pixel offsets to normalised kernels.
212209
"""
213210
# We use floordiv and multiply to give sensible results for both odd / even
214211
# oversampling values:

0 commit comments

Comments
 (0)