Add type hint example function (#137)

* Add function using type hinting  to be used in the dev-guide as an example

* Update src/ansys_sphinx_theme/type_hint_example.py

Co-authored-by: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com>

* Code style

* Apply suggestions from code review

Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>

* Fix docstyle

Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
Co-authored-by: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com>
Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>

src/ansys_sphinx_theme/type_hint_example.py

@@ -0,0 +1,31 @@
+"""Module containing an example function using type hinting."""
+from typing import Union
+
+
+def type_hint_func(param1: int = 1, param2: str = "test", param3: Union[int, float] = 1) -> bool:
+    """Summary containing the function description.
+
+    Extended description of the function. Can span multiple lines and
+    provides a general overview of the function.
+
+    Parameters
+    ----------
+    param1 :
+        Description of an integer parameter.
+    param2 :
+        Description of a string parameter.
+    param3 :
+        Parameter that can be either int or float using Union (typing).
+
+    Returns
+    -------
+    bool
+        Description of the returned value.
+
+    Examples
+    --------
+    >>> func(1, 'foo', 1)
+    True
+
+    """
+    return True