From 26548181bf406a9c7dc8bfc9b1f6c58cf7a3e6e2 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Sat, 7 Feb 2015 19:29:32 -0600 Subject: [PATCH 1/3] Be more specific about citation not found error --- doc/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 015693e1..50deb4e2 100644 --- a/doc/README.md +++ b/doc/README.md @@ -8,7 +8,8 @@ Sphinx is needed to build doc. Install with `pip install sphinx`. - "citation not found: R###" $ cd doc/build; grep -rin R### . - There is probably an underscore after the reference (e.g. [1]_) + There is probably an underscore after a reference + in the first line of a docstring (e.g. [1]_) - "Duplicate citation R###, other instance in..."" There is probably a [2] without a [1] in one of From 73aa5a22ba68e5da84a16de743fda903a186e0b2 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Sat, 7 Feb 2015 19:29:50 -0600 Subject: [PATCH 2/3] Remove citations in first line of docstring --- skimage/filters/rank/generic.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/skimage/filters/rank/generic.py b/skimage/filters/rank/generic.py index 31e80b76..fd718b98 100644 --- a/skimage/filters/rank/generic.py +++ b/skimage/filters/rank/generic.py @@ -1,5 +1,5 @@ """The local histogram is computed using a sliding window similar to the method -described in [1]. +described in [1]_. Input image can be 8-bit or 16-bit, for 16-bit input images, the number of histogram bins is determined from the maximum value present in the image. @@ -749,7 +749,7 @@ def tophat(image, selem, out=None, mask=None, shift_x=False, shift_y=False): def noise_filter(image, selem, out=None, mask=None, shift_x=False, shift_y=False): - """Noise feature as described in [1]. + """Noise feature. Parameters ---------- @@ -800,10 +800,11 @@ def noise_filter(image, selem, out=None, mask=None, shift_x=False, def entropy(image, selem, out=None, mask=None, shift_x=False, shift_y=False): - """Local entropy [1]. + """Local entropy. The entropy is computed using base 2 logarithm i.e. the filter returns the - minimum number of bits needed to encode the local greylevel distribution. + minimum number of bits needed to encode the local greylevel + distribution. Parameters ---------- From ed7aecdc4c4b837f24de838f265d18aeb5cabdb3 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Sat, 7 Feb 2015 19:33:30 -0600 Subject: [PATCH 3/3] Fix links --- skimage/feature/texture.py | 2 +- skimage/morphology/grey.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/skimage/feature/texture.py b/skimage/feature/texture.py index 7e23f0be..beb66ff9 100644 --- a/skimage/feature/texture.py +++ b/skimage/feature/texture.py @@ -259,7 +259,7 @@ def local_binary_pattern(image, P, R, method='default'): finer quantization of the angular space which is gray scale and rotation invariant. * 'nri_uniform': non rotation-invariant uniform patterns variant - which is only gray scale invariant [2]. + which is only gray scale invariant [2]_. * 'var': rotation invariant variance measures of the contrast of local image texture which is rotation but not gray scale invariant. diff --git a/skimage/morphology/grey.py b/skimage/morphology/grey.py index 0642a104..fdc8381c 100644 --- a/skimage/morphology/grey.py +++ b/skimage/morphology/grey.py @@ -53,7 +53,7 @@ def _invert_selem(selem): """Change the order of the values in `selem`. This is a patch for the *weird* footprint inversion in - `nd.grey_morphology` [1]. + `nd.grey_morphology` [1]_. Parameters ----------