Skip to content

Commit 94bea93

Browse files
committed
fix(docs): 📝 add missing dots at the end of docstrings and remove new lines
1 parent 65daf40 commit 94bea93

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

src/imcflibs/imagej/processing.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def filter_options(filter_method, filter_radius, do_3d=False):
2929
Returns
3030
-------
3131
tuple[str, str]
32-
The filter name and options strings
32+
The filter name and options strings.
3333
"""
3434

3535
if do_3d:
@@ -59,8 +59,7 @@ def threshold_options(threshold_method, do_3d=True):
5959
Returns
6060
-------
6161
tuple[str, str]
62-
The auto threshold options and the convert to binary options strings
63-
62+
The auto threshold options and the convert to binary options strings.
6463
"""
6564

6665
auto_threshold_options = (
@@ -97,8 +96,9 @@ def apply_filter(imp, filter_method, filter_radius, do_3d=False):
9796
Returns
9897
-------
9998
ij.ImagePlus
100-
Filtered ImagePlus
99+
Filtered ImagePlus.
101100
"""
101+
102102
log.info("Applying filter %s with radius %d" % (filter_method, filter_radius))
103103

104104
if filter_method not in [
@@ -150,7 +150,7 @@ def apply_rollingball_bg_subtraction(
150150
Returns
151151
-------
152152
ij.ImagePlus
153-
Filtered ImagePlus
153+
Filtered ImagePlus.
154154
"""
155155
log.info("Applying rolling ball with radius %d" % rolling_ball_radius)
156156

@@ -195,9 +195,9 @@ def rolling_ball_options(
195195
Returns
196196
-------
197197
str
198-
The options string for the "Subtract Background..." macro command
199-
198+
The options string for the "Subtract Background..." macro command.
200199
"""
200+
201201
parts = ["rolling=" + str(rolling_ball_radius)]
202202
if light_background:
203203
parts.append("light")
@@ -226,7 +226,7 @@ def apply_threshold(imp, threshold_method, do_3d=True):
226226
Returns
227227
-------
228228
ij.ImagePlus
229-
Thresholded ImagePlus
229+
Thresholded ImagePlus.
230230
"""
231231

232232
log.info("Applying threshold method %s" % threshold_method)

0 commit comments

Comments
 (0)