Update DTDV411_style.ipynb

Author: giovannivolpe

tutorials/4-developers/DTDV411_style.ipynb

@@ -67,7 +67,7 @@
     "\n",
     "from typing import Literal\n",
     "\n",
-    "def process_values(mode: Literal[\"sum\", \"average\"]) -> float:\n",
+    "def process_values(mode: Literal[\"sum\", \"average\"]) -> None:\n",
     "    pass"
    ]
   },
@@ -86,7 +86,7 @@
    "source": [
     "# Incorrect\n",
     "\n",
-    "def process_values(mode: str) -> float:\n",
+    "def process_values(mode: str) -> None:\n",
     "    pass"
    ]
   },
@@ -114,7 +114,7 @@
    "source": [
     "# Correct\n",
     "\n",
-    "def calculate_average(numbers: list[int]) -> float:\n",
+    "def calculate_average(numbers: list[int]) -> None:\n",
     "    pass"
    ]
   },
@@ -133,7 +133,7 @@
    "source": [
     "# Incorrect\n",
     "\n",
-    "def calculate_average(numbers: list) -> float:\n",
+    "def calculate_average(numbers: list) -> None:\n",
     "    pass"
    ]
   },
@@ -192,7 +192,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "**NOTE:** Not all imports need to be placed at the top of the module. You can import libraries inside a class if they are only used within that class, or inside conditional statements if necessary."
+    "**NOTE:** Not all imports need to be placed at the top of the module. You can import libraries inside a class if they are only used within that class, or even inside conditional statements if necessary."
    ]
   },
   {
@@ -226,7 +226,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "**NOTE:** The NumpyDoc guide specifies using phrases such as `int or list of int` rather than shorthand notations such as `int | list[int]`. We also prefer the phrases in the docstrings."
+    "**NOTE:** The NumpyDoc guide specifies using phrases such as `int or float` rather than shorthand notations such as `int | float`. We also prefer the phrases in the docstrings."
    ]
   },
   {
@@ -245,7 +245,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -275,12 +275,12 @@
     "    param3: \"numpy\" or \"torch\", optional\n",
     "        This is a description of the third parameter. When the parameter is\n",
     "        optional, its default value should be provided; in this case, \"numpy\".\n",
-    "    param4: list of int or None, optional\n",
+    "    param4: list[int] or None, optional\n",
     "        This is a description of the fourth parameter. It defaults to None.\n",
     "\n",
     "    Returns\n",
     "    -------\n",
-    "    list of int\n",
+    "    list[int]\n",
     "        This is a description of the return value. This can also be on multiple\n",
     "        lines.\n",
     "\n",
@@ -292,6 +292,10 @@
     "\n",
     "    Examples\n",
     "    --------\n",
+    "    >>> import deeptrack as dt\n",
+    "\n",
+    "    This line of code uses the function:\n",
+    "    \n",
     "    >>> my_function(1, \"a\")\n",
     "    [1, 2, 3]\n",
     "\n",
@@ -309,7 +313,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -425,7 +429,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 10,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -466,12 +470,7 @@
     "\n",
     "Functions:\n",
     "\n",
-    "- `my_function(param1, param2)`\n",
-    "\n",
-    "    def my_function(\n",
-    "        param1: int,\n",
-    "        param2: str,\n",
-    "    ) -> list[int]\n",
+    "- `my_function(param1, param2) -> list[int]`\n",
     "\n",
     "    Short description of the function.\n",
     "\n",