chore(examples): Automatic commit of example files in Markdown and Ju…

…pyter Notebook format.
RWTH-EBC · Dec 3, 2024 · 2e7be6e · 2e7be6e
1 parent cc2bf65
commit 2e7be6e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 28 deletions.
diff --git a/docs/jupyter_notebooks/e1_pull_DWD_historical_to_all_output_formats.ipynb b/docs/jupyter_notebooks/e1_pull_DWD_historical_to_all_output_formats.ipynb
@@ -1,23 +1,9 @@
 {
     "cells": [
-        {
-            "cell_type": "code",
-            "execution_count": null,
-            "metadata": {},
-            "outputs": [],
-            "source": "\"\"\"Contains examples\"\"\"\n"
-        },
         {
             "cell_type": "markdown",
             "metadata": {},
-            "source": "pylint: disable=C0415, C0103\nlet pylint ignore to import from aixweather (Import outside toplevel), and ignore that pylint\nsuggests e1_pull_DWD_historical_to_all_output_formats would not be snake_case.\n"
-        },
-        {
-            "cell_type": "code",
-            "execution_count": null,
-            "metadata": {},
-            "outputs": [],
-            "source": "import datetime as dt\n"
+            "source": "Historical DWD pull example\n"
         },
         {
             "cell_type": "markdown",
@@ -46,14 +32,14 @@
         {
             "cell_type": "markdown",
             "metadata": {},
-            "source": "Step 0: Initiate the project class which contains or creates all variables and functions.\n"
+            "source": "Step 0: Initiate the project class which contains or creates all variables and functions.\nFor this, we use the datetime module to specify dates.\n"
         },
         {
             "cell_type": "code",
             "execution_count": null,
             "metadata": {},
             "outputs": [],
-            "source": "DWD_pull_project = ProjectClassDWDHistorical(\n    start=dt.datetime(2022, 1, 1),\n    end=dt.datetime(2023, 1, 1),\n    station=15000,\n    # specify whether nan-values should be filled when exporting\n    fillna=True,\n    # define results path if desired\n    abs_result_folder_path=None,\n)\n"
+            "source": "import datetime as dt\nDWD_pull_project = ProjectClassDWDHistorical(\n    start=dt.datetime(2022, 1, 1),\n    end=dt.datetime(2023, 1, 1),\n    station=15000,\n    # specify whether nan-values should be filled when exporting\n    fillna=True,\n    # define results path if desired\n    abs_result_folder_path=None,\n)\n"
         },
         {
             "cell_type": "markdown",

diff --git a/docs/source/examples/e1_pull_DWD_historical_to_all_output_formats.md b/docs/source/examples/e1_pull_DWD_historical_to_all_output_formats.md
@@ -1,15 +1,5 @@
 
-```python
-"""Contains examples"""
-```
-
-pylint: disable=C0415, C0103
-let pylint ignore to import from aixweather (Import outside toplevel), and ignore that pylint
-suggests e1_pull_DWD_historical_to_all_output_formats would not be snake_case.
-
-```python
-import datetime as dt
-```
+Historical DWD pull example
 
 Enable logging, this is just get more feedback through the terminal
 
@@ -26,8 +16,10 @@ from aixweather.project_class import ProjectClassDWDHistorical
 ```
 
 Step 0: Initiate the project class which contains or creates all variables and functions.
+For this, we use the datetime module to specify dates.
 
 ```python
+import datetime as dt
 DWD_pull_project = ProjectClassDWDHistorical(
     start=dt.datetime(2022, 1, 1),
     end=dt.datetime(2023, 1, 1),