Organize and Sort Functions into Relevant Classes

[Polichinel]

Organize and Sort Functions into Relevant Classes

These issues must be solved first:

• Create ADR for Naming Conventions #157
• Create ADR for Class Structure of Utilities #158
• Review and Document Best Practices for Package Creation and Management #159

Description:
Before restructuring the directory, review all existing functions and organize them into the relevant classes as defined in the class structure ADR. This will ensure a consistent, modular structure that aligns with the documented class responsibilities and boundaries, making the subsequent directory restructuring more efficient and organized. This process should follow the guidance in the class structure ADR and remain consistent with the md&d_python_style_guide and the naming ADR.

Sorting Guidelines

• Function Assignment:

  • Review each function to ensure it aligns with the purpose and scope of the relevant class as outlined in the ADR.
  • If a function does not fit into any of the existing classes, determine whether a new class is needed or if the function should be refactored to align with an existing class.

• Refactoring for Consistency:

  • Rename functions as necessary to ensure they are descriptive and follow the naming conventions established in the naming ADR.
  • Refactor functions to adhere to the class responsibilities and to avoid overlaps or redundancy.

• Documentation:

  • Ensure each function has clear docstrings describing its purpose, inputs, and outputs.
  • Document any changes in the relevant ADR or update the README if new classes or significant changes are introduced.

Objective:
Organize and sort all functions into well-defined classes, aligning with the class structure ADR, to ensure modularity and clarity. This will simplify the directory restructuring and enhance maintainability and readability across the codebase.

Notes
Consider making multiple PRs as part of this issue, so as not to overwhelm the reviewers with a huge PR in the end...

Tasks:

• Review each function and assign it to the appropriate class based on the ADR.
• Refactor functions as needed to match the naming conventions and class responsibilities.
• Verify the scope of each class and ensure no overlaps or redundancies exist.
• Add or update docstrings for each function to ensure clear documentation.
• Confirm alignment with the md&d_python_style_guide and relevant ADRs
• Update the md&d_python_style_guide and relevant ADRs if need be.

Labels: refactor, documentation, enhancement