Skip to content

Conversation

@AdrianEpi
Copy link
Owner

Description

Created Dir module and deleted old doc system

This pull request includes significant changes to the project structure and documentation, primarily focusing on the removal of Sphinx documentation files and the introduction of new directory and file management modules. The most important changes include the deletion of Sphinx-related files, renaming and updating file paths, and the addition of a new directory manager module with corresponding tests.

Removal of Sphinx documentation:

  • Removed Makefile, conf.py, index.rst, and make.bat related to Sphinx documentation. [1] [2] [3] [4]
  • Deleted Sphinx section from README.md.

Project structure updates:

  • Renamed modules/files/file_manager.py to modules/filesystem/file_manager.py and updated references accordingly. [1] [2] [3]
  • Updated project name in file headers from "Personal" to "Python Modules". [1] [2] [3]

New functionality:

  • Added modules/filesystem/dir_manager.py to manage directory operations, including listing directories and files, creating and deleting directories, and checking directory existence.
  • Added tests/test_dir_manager.py to provide unit tests for the new directory manager module.

@AdrianEpi AdrianEpi added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 29, 2025
@AdrianEpi AdrianEpi requested a review from Copilot March 29, 2025 10:30
@AdrianEpi AdrianEpi self-assigned this Mar 29, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes obsolete Sphinx documentation and restructures project files while introducing a new directory manager module with corresponding tests.

  • Removed Sphinx documentation files and Sphinx instructions from README.
  • Renamed file paths from modules/files to modules/filesystem and updated file headers.
  • Added modules/filesystem/dir_manager.py for directory operations along with tests in tests/test_dir_manager.py.

Reviewed Changes

Copilot reviewed 12 out of 15 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/test_file_manager.py Updated test headers and import paths for file_manager.
tests/test_dir_manager.py Introduced new tests for the directory manager functionality.
modules/filesystem/file_manager.py Updated file header and adjusted description to reflect changes.
modules/filesystem/dir_manager.py Added new directory manager module with various directory methods.
modules/errors/error_handler.py Updated project name in file header.
modules/datetime/date.py Updated project name and header information.
modules/init.py Removed outdated header comments.
conf.py Deleted the Sphinx configuration file as part of documentation removal.
README.md Removed obsolete Sphinx section.
Files not reviewed (3)
  • Makefile: Language not supported
  • index.rst: Language not supported
  • make.bat: Language not supported
Comments suppressed due to low confidence (2)

modules/filesystem/dir_manager.py:79

  • Ensure that DirManager.list_files returns a list rather than an error message string so that list_all_files_recursive consistently processes a list. Consider handling error cases explicitly before concatenating lists.
files = DirManager.list_files(path, extension)

modules/filesystem/file_manager.py:21

  • Typo in comment: 'cotains' should be 'contains'.
This class describes a file manager, it cotains all the static methods

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@AdrianEpi AdrianEpi merged commit ed29c8d into master Mar 29, 2025
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants