Conversation
Contributor
There was a problem hiding this comment.
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Makefile,conf.py,index.rst, andmake.batrelated to Sphinx documentation. [1] [2] [3] [4]README.md.Project structure updates:
modules/files/file_manager.pytomodules/filesystem/file_manager.pyand updated references accordingly. [1] [2] [3]New functionality:
modules/filesystem/dir_manager.pyto manage directory operations, including listing directories and files, creating and deleting directories, and checking directory existence.tests/test_dir_manager.pyto provide unit tests for the new directory manager module.