From 1a99c2949c793c4bf00bfc39310b4cb90c823108 Mon Sep 17 00:00:00 2001 From: Jesper Sandvig Mariegaard <34088801+jsmariegaard@users.noreply.github.com> Date: Wed, 1 Nov 2023 08:58:30 +0100 Subject: [PATCH] move and add links --- .../{Project_overview.md => README.md} | 20 +++++++------------ 1 file changed, 7 insertions(+), 13 deletions(-) rename projects/data_cleaning/{Project_overview.md => README.md} (55%) diff --git a/projects/data_cleaning/Project_overview.md b/projects/data_cleaning/README.md similarity index 55% rename from projects/data_cleaning/Project_overview.md rename to projects/data_cleaning/README.md index fb5fab5..75aa790 100644 --- a/projects/data_cleaning/Project_overview.md +++ b/projects/data_cleaning/README.md @@ -1,48 +1,42 @@ # Course project: Time Series Data Cleaning -## Module 1: GitHub and basic functions +## [Module 1: GitHub and basic functions](Project_module_01.md) - 1.1 GitHub repo - 1.2 Functions -## Module 2: Modules and classes +## [Module 2: Modules and classes](Project_module_02.md) - 2.1 Function arguments - 2.2 Modules - 2.3 Classes - - -## Module 3: Installable package and pytest +## [Module 3: Installable package and pytest](Project_module_03.md) - 3.1 Installable package - 3.2 Pytest - -## Module 4: GitHub actions and auto-formatting +## [Module 4: GitHub actions and auto-formatting](Project_module_04.md) - 4.1 Github Action - 4.2 Ruff - 4.3 Black - 4.4 pyproject.toml - -## Module 5: Object-oriented design +## [Module 5: Object-oriented design](Project_module_05.md) - 5.1 Type Hints - 5.2 Data class - 5.3 Module level function - 5.4 Composition or inheritance - -## Module 6: Documentation +## [Module 6: Documentation](Project_module_06.md) - 6.1 README - 6.2 Docstrings - 6.3 mkdocs - -## Module 7: Publishing +## [Module 7: Publishing](Project_module_07.md) - Add a license - Change version number to 0.1.0 - Build the package with hatchling.