Merge pull request #1 from MeteoSwiss/new-feature

add a very cool new feature (demo)

Author: LeonardKnirsch

AUTHORS

@@ -1 +1,2 @@
-Michele Cattaneo
+Michele Cattaneo
+Leonard Knirsch

CHANGELOG.rst

@@ -2,40 +2,14 @@
 Changelog
 =========
 
-Version 0.2.0
--------------
-
-Features
-''''''''
-
-- Lorem ipsum dolor sit
-- Consectetur adipiscing elit
-- Sed do eiusmod tempor incididunt
-
-Bug Fixes
-'''''''''
-
-- Ut labore et dolore magna aliqua
 
-Breaking Changes
-''''''''''''''''
-
-- Ut enim ad minim veniam
-- Quis nostrud exercitation ullamco laboris
-
-
-Version 0.1.0
+Version 1.1.0
 -------------
+* Added `another_dummy_func` to `main.py` that converts an integer to a float.
+* Updated this Changelog
 
-Features
-''''''''
-
-- Nisi ut aliquip
-- Ex ea commodo consequat
 
-Bug Fixes
-'''''''''
+Version 1.0.0
+----------------
 
-- Duis aute irure dolor in
-- Voluptate velit esse
-- Cillum dolore eu fugiat nulla pariatur excepteur sint oocaecat
+* Initial release.

open_source_template/main.py

@@ -17,3 +17,14 @@ def dummy_func(input_value: float) -> int:
     :rtype: int
     """
     return int(input_value)
+
+def another_dummy_func(input_value: int) -> float:
+    """
+    Another dummy function.
+
+    :param input_value: Argument to the function.
+    :type input_value: int
+    :return: A float.
+    :rtype: float
+    """
+    return float(input_value)

test/test_dummy_library.py

@@ -1,8 +1,13 @@
-from open_source_template.main import dummy_func
+from open_source_template.main import another_dummy_func, dummy_func
 
 
 def test_dummy_func():
-    """Test the correctness of dummy_func.
-    """
+    """Test the correctness of dummy_func."""
 
     assert dummy_func(3.2) == 3
+
+
+def test_another_dummy_func():
+    """Test the correctness of another_dummy_func."""
+
+    assert another_dummy_func(5) == 5.0