Skip to content

Commit 22bf8bf

Browse files
committed
Minor docstring cleanups
1 parent f5b73d4 commit 22bf8bf

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

src/imcflibs/imagej/misc.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,18 @@ def elapsed_time_since(start, end=None):
5353

5454

5555
def percentage(part, whole):
56-
"""Returns the percentage of a value based on total
56+
"""Calculate the percentage of a value based on total.
5757
5858
Parameters
5959
----------
6060
part : float
61-
Part
61+
Part.
6262
whole : float
63-
Complete size
63+
Complete size.
6464
6565
Returns
6666
-------
6767
float
68-
Percentage
6968
"""
7069
return 100 * float(part) / float(whole)
7170

@@ -81,7 +80,7 @@ def calculate_mean_and_stdv(float_values):
8180
Returns
8281
-------
8382
[float, float]
84-
Mean and standard deviation of the list.
83+
Mean (1st item) and standard deviation (2nd item) of the list.
8584
"""
8685
mean = sum(float_values) / len(float_values)
8786
tot = 0.0
@@ -141,8 +140,8 @@ def find_focus(imp):
141140
def progressbar(progress, total, line_number, prefix=""):
142141
"""Progress bar for the IJ log window.
143142
144-
Shows a progress bar in the log window of Fiji at a specific line
145-
independant from the main Fiji progress bar
143+
Show a progress bar in the log window of Fiji at a specific line independent
144+
of the main Fiji progress bar.
146145
147146
Parameters
148147
----------
@@ -172,7 +171,7 @@ def progressbar(progress, total, line_number, prefix=""):
172171

173172

174173
def timed_log(message, as_string=False):
175-
"""Print a log message with a timestamp added
174+
"""Print a message to the ImageJ log window with a timestamp added.
176175
177176
Parameters
178177
----------

0 commit comments

Comments
 (0)