Skip to content

Commit de8b801

Browse files
committed
Fix documentation format
1 parent ed73d4c commit de8b801

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

source-code/oo_vs_functional.ipynb

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -285,8 +285,8 @@
285285
" '''create a coroutine that keeps track of descriptive\n",
286286
" statistics of a data stream\n",
287287
" \n",
288-
" Params\n",
289-
" ------\n",
288+
" Parameters\n",
289+
" ----------\n",
290290
" stats : dict\n",
291291
" dictrionary that will hold the statistics, i.e., number of values,\n",
292292
" mean and standard deviation. The dictionary will contain None for\n",
@@ -396,8 +396,8 @@
396396
" '''create a coroutine that keeps track of descriptive\n",
397397
" statistics of a data stream\n",
398398
" \n",
399-
" Params\n",
400-
" ------\n",
399+
" Parameters\n",
400+
" ----------\n",
401401
" stats : dict\n",
402402
" dictrionary that will hold the statistics, i.e., number of values,\n",
403403
" mean and standard deviation. The dictionary will contain None for\n",
@@ -710,8 +710,8 @@
710710
" def __init__(self, sum_value: float=0.0, sum2: float=0.0, n: int=0):\n",
711711
" '''constructor for Stats objects\n",
712712
" \n",
713-
" Params\n",
714-
" ------\n",
713+
" Parameters\n",
714+
" ----------\n",
715715
" Either none, which initializes an object that has seen no data yet, or\n",
716716
" \n",
717717
" sum_value: float\n",
@@ -777,8 +777,8 @@
777777
" '''functional operator, creates a new Stats object when a value is added\n",
778778
" called as stats + value\n",
779779
" \n",
780-
" Params\n",
781-
" ------\n",
780+
" Parameters\n",
781+
" ----------\n",
782782
" value: float\n",
783783
" new data value to be added to the statistics\n",
784784
" \n",
@@ -792,8 +792,8 @@
792792
" def __iadd__(self, value: float):\n",
793793
" '''non-functional operator, updates the Stats object when a value is added\n",
794794
" \n",
795-
" Params\n",
796-
" ------\n",
795+
" Parameters\n",
796+
" ----------\n",
797797
" value: float\n",
798798
" new data value to be added to the statistics\n",
799799
" \n",
@@ -1568,7 +1568,7 @@
15681568
"name": "python",
15691569
"nbconvert_exporter": "python",
15701570
"pygments_lexer": "ipython3",
1571-
"version": "3.10.9"
1571+
"version": "3.11.2"
15721572
}
15731573
},
15741574
"nbformat": 4,

0 commit comments

Comments
 (0)