add method headers and doctests

Author: coryallegory

project_euler/problem_89/sol1.py

@@ -35,6 +35,12 @@
 
 
 def parse_roman_numerals(numerals: str) -> int:
+    """
+    Converts a string of roman numerals to an integer.
+    e.g.
+    >>> parse_roman_numerals("LXXXIX")
+    89
+    """
 
     num = 0
 
@@ -53,6 +59,12 @@ def parse_roman_numerals(numerals: str) -> int:
 
 
 def generate_roman_numerals(num: int) -> str:
+    """
+    Generates a string of roman numerals for a given integer.
+    e.g.
+    >>> generate_roman_numerals(89)
+    'LXXXIX'
+    """
 
     numerals = ""
 
@@ -101,6 +113,13 @@ def generate_roman_numerals(num: int) -> str:
 
 
 def solution() -> int:
+    """
+    Calculates and returns the answer to project euler problem 89.
+
+    Answer:
+    >>> solution()
+    743
+    """
 
     savings = 0