fix template init test, make example module actually pass the linting rules lol

Author: sneakers-the-rat

template/pyproject.toml.jinja

@@ -177,7 +177,11 @@ lines-after-imports = 1
 
 [tool.pydoclint]
 style = "numpy"
+{%- if use_types %}
+arg-type-hints-in-signature = true
+{%- else  %}
 arg-type-hints-in-signature = false
+{%- endif %}
 arg-type-hints-in-docstring = true
 check-return-types = false
 check-yield-types = false

template/src/{{ package_name }}/__init__.py.jinja

@@ -1,4 +1,8 @@
 {% include pathjoin("includes", "licenses", "header.txt.jinja") %}
 
-"""Add a docstring here for the init module. This might include a very
-brief description of the package, its purpose, and any important notes."""
+"""
+Add a docstring here for the init module.
+
+This might include a very brief description of the package,
+its purpose, and any important notes.
+"""

template/src/{{ package_name }}/example.py.jinja

@@ -1,26 +1,29 @@
 """
-A module that adds numbers together. You may want to delete this module or
-modify it for your package. It's generally good practice to have a docstring
+A module that adds numbers together.
+
+You may want to delete this module or modify it for your package.
+It's generally good practice to have a docstring
 that explains the purpose of the module, at the top.
 """
 
-def add_numbers(a, b):
+def add_numbers(a: float, b: float) -> float:
     """
     Add two numbers together and return the result.
+
     This is an example function with a numpy style docstring.
     We recommend using this style for consistency and readability.
 
     Parameters
     ----------
-    a : int or float
+    a : float
         The first number to add.
-    b : int or float
+    b : float
         The second number to add.
 
     Returns
     -------
-    int
+    float
         The sum of the two numbers.
-    """
 
+    """
     return a + b