Skip to content
Snippets Groups Projects
Commit 625cf9e1 authored by niklasfranz's avatar niklasfranz
Browse files

"refactor: line length limit < 80

- updated docs/architecture.md"
parent 3b015a62
No related branches found
No related tags found
No related merge requests found
......@@ -2,9 +2,9 @@
The goal of this system is to develop a Python library that provides
dataset manipulation and visualization functionalities for use in Jupyter
Notebooks. In order to create a suitable architecture, we first had to make a
decision for a programming approach. In this project, we settled for an Object-Oriented
Programming (OOP) approach to ensure modularity, reusability, and
maintainability of our codebase.
decision for a programming approach. In this project, we settled for an
Object-Oriented Programming (OOP) approach to ensure modularity, reusability,
and maintainability of our codebase.
The system will encompass two classes, `Dataset` and `Plotter`, which will
expose functions that implement the two core functionalities of our system:
......@@ -20,8 +20,8 @@ defined in `src/Plotter.py`.
# UML Class Diagram
To further extend this system architecture description and elaborate on the
class structure and functionality, we have created an UML-Diagram encompassing both classes.
It describes their class attributes and functions:
class structure and functionality, we have created an UML-Diagram encompassing
both classes. It describes their class attributes and functions:
![UML Diagram](./class_diagram.png)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment