From ec64872fd5058898833652d454750e0851676be8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Thu, 20 Aug 2015 19:08:54 -0400 Subject: [PATCH] Some doc string fixes for recently merged code --- doc/examples/plot_edge_modes.py | 4 ++-- skimage/_shared/interpolation.pyx | 14 +++++++------- skimage/_shared/utils.py | 4 ++-- skimage/transform/_geometric.py | 3 +-- skimage/util/apply_parallel.py | 11 ++++++----- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/examples/plot_edge_modes.py b/doc/examples/plot_edge_modes.py index d68abf02..8689e4a8 100644 --- a/doc/examples/plot_edge_modes.py +++ b/doc/examples/plot_edge_modes.py @@ -4,8 +4,8 @@ Interpolation: Edge Modes ========================= This example illustrates the different edge modes available during -interpolation in routines such as ``skimage.transform.rescale`` and -``skimage.transform.resize``. +interpolation in routines such as `skimage.transform.rescale` and +`skimage.transform.resize`. """ from skimage._shared.interpolation import extend_image import skimage.data diff --git a/skimage/_shared/interpolation.pyx b/skimage/_shared/interpolation.pyx index 583fe43c..eeaddcbd 100644 --- a/skimage/_shared/interpolation.pyx +++ b/skimage/_shared/interpolation.pyx @@ -5,13 +5,13 @@ from .utils import _mode_deprecations def coord_map_py(Py_ssize_t dim, long coord, mode): - """interpolation.coord_map python wrapper""" + """Python wrapper for `interpolation.coord_map`.""" cdef char mode_c = ord(mode[0].upper()) return coord_map(dim, coord, mode_c) def extend_image(image, pad=10, mode='constant', cval=0): - """Pad a 2D image by ``pad`` pixels on each side. + """Pad a 2D image by `pad` pixels on each side. Parameters ---------- @@ -31,11 +31,11 @@ def extend_image(image, pad=10, mode='constant', cval=0): extended : ndarray The extended version of the input image. - Note - ---- - For image padding, ``skimage.util.pad`` should be used instead. This - function is intended only for testing get_pixel2d and demonstrating the - coordinate mapping modes implemented in ``coord_map``. + Notes + ----- + For image padding, `skimage.util.pad` should be used instead. This + function is intended only for testing `get_pixel2d` and demonstrating the + coordinate mapping modes implemented in `coord_map`. """ mode = _mode_deprecations(mode) cdef: diff --git a/skimage/_shared/utils.py b/skimage/_shared/utils.py index eadc3015..6b0607e9 100644 --- a/skimage/_shared/utils.py +++ b/skimage/_shared/utils.py @@ -166,11 +166,11 @@ def assert_nD(array, ndim, arg_name='image'): def _mode_deprecations(mode): - """ to be used by functions to update deprecated mode names in + """Used to update deprecated mode names in `skimage._shared.interpolation.pyx`.""" if mode.lower() == 'nearest': warnings.warn(skimage_deprecation( - "Mode 'nearest' has been renamed 'edge'. Mode 'nearest' will be " + "Mode 'nearest' has been renamed to 'edge'. Mode 'nearest' will be " "removed in a future release.")) mode = 'edge' return mode diff --git a/skimage/transform/_geometric.py b/skimage/transform/_geometric.py index 3d459b36..c9249444 100644 --- a/skimage/transform/_geometric.py +++ b/skimage/transform/_geometric.py @@ -13,8 +13,7 @@ from ._warps_cy import _warp_fast def _to_ndimage_mode(mode): - """ Convert from a numpy.pad mode name to the corresponding ndimage - mode. """ + """Convert from `numpy.pad` mode name to the corresponding ndimage mode.""" mode = _mode_deprecations(mode.lower()) mode_translation_dict = dict(edge='nearest', symmetric='reflect', reflect='mirror') diff --git a/skimage/util/apply_parallel.py b/skimage/util/apply_parallel.py index c19b4bfd..0f586216 100644 --- a/skimage/util/apply_parallel.py +++ b/skimage/util/apply_parallel.py @@ -5,12 +5,13 @@ __all__ = ['apply_parallel'] def _get_chunks(shape, ncpu): - """ - Split the array into equal sized chunks based on the number of + """Split the array into equal sized chunks based on the number of available processors. The last chunk in each dimension absorbs the - remainder array elements if the number of cpus does not divide evenly into + remainder array elements if the number of CPUs does not divide evenly into the number of array elements. + Examples + -------- >>> _get_chunks((4, 4), 4) ((2, 2), (2, 2)) >>> _get_chunks((4, 4), 2) @@ -77,8 +78,8 @@ def apply_parallel(function, array, chunks=None, depth=0, mode=None, Notes ----- - Numpy edge modes `symmetric`, `wrap` and `edge` are converted to the - equivalent `dask` boundary modes `reflect`, `periodic` and `nearest`, + Numpy edge modes 'symmetric', 'wrap', and 'edge' are converted to the + equivalent `dask` boundary modes 'reflect', 'periodic' and 'nearest', respectively. """ import dask.array as da