Skip to content

Commit f788ed1

Browse files
committed
added documentation for standard deviation function
1 parent 94cfdda commit f788ed1

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

src/dumbpy/std_deviation.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
"""
2+
A module that calculates the standard deviation of a list of numbers.
3+
4+
"""
5+
6+
def std_deviation(input):
7+
"""
8+
Calculate the standard deviation of the inputted list and return the result.
9+
10+
Parameters
11+
----------
12+
input : list
13+
A list of numbers.
14+
15+
Returns
16+
-------
17+
float
18+
The standard deviation of the list of numbers.
19+
20+
Examples
21+
--------
22+
>>> std_deviation([1, 1, 1, 1])
23+
0
24+
>>> add_numbers([1, 0, 1, 0])
25+
0.5
26+
27+
"""
28+

0 commit comments

Comments
 (0)