🎨 update tutorial with some more comments

Author: enryH

docs/tutorial/tutorial.ipynb

@@ -21,6 +21,16 @@
     "from python_package import hello_world"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "78609dba",
+   "metadata": {},
+   "source": [
+    "## Hello World\n",
+    "mockup module contains a function which returns a string repeating the 'hello world' string\n",
+    "n-times."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -32,6 +42,14 @@
     "ret"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "b3012415",
+   "metadata": {},
+   "source": [
+    "Print the string."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -42,6 +60,14 @@
     "print(ret)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "076361ca",
+   "metadata": {},
+   "source": [
+    "Inspect the signature."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -53,15 +79,11 @@
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4ae5341c",
-   "metadata": {
-    "title": "markdown"
-   },
-   "outputs": [],
+   "cell_type": "markdown",
+   "id": "916c31f2",
+   "metadata": {},
    "source": [
-    "# Simple example for a recipe showing what the package can do."
+    "Simple example for a recipe showing what the package can do."
    ]
   }
  ],

docs/tutorial/tutorial.py

@@ -7,15 +7,26 @@
 # %%
 from python_package import hello_world
 
+# %% [markdown]
+# ## Hello World
+# mockup module contains a function which returns a string repeating the 'hello world' string
+# n-times.
+
 # %%
 ret = hello_world(2)
 ret
 
+# %% [markdown]
+# Print the string.
+
 # %%
 print(ret)
 
+# %% [markdown]
+# Inspect the signature.
+
 # %%
 # hello_world?
 
-# %%
+# %% [markdown]
 # Simple example for a recipe showing what the package can do.