PEP8 Enhancement #1
Open
Conversation
This file contains 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
Added pylint as GitHub actions to improve code quality.
…ed unit tests using Pytest
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.
Hello dear Camila,
This PR contains several enhancements to the repository as outlined below:
PEP8 Compliance: The Python code in this project has been refactored to comply with PEP8 style guidelines. This will make it easier for other developers to read and understand the code.
Code Comments and Documentation: Additional docstrings with reStructured Text format have been added throughout the codebase to explain what each section of the code is doing. A more detailed explanation has also been provided in the README file on how to manage the GitHub process.
Linter Addition: Pylint has been added to the project to automatically check the code for potential errors and enforce some parts of the PEP8 guideline. I also added its specific GitHub Action in the workflow so the yml file can be used to work in a similar way to the pre-commit hook.
Formatter Addition: Black has been added to the project. This will help maintain the consistency of the code's appearance, making it easier to read and understand.
Pre-commit Hook: As a bonus, a pre-commit hook has been set up to automatically run the linter and formatter before each commit.
MyPy: Another bonus. MyPY has been added, which is an optional static type checker for the type hints/annotations on variables and functions in the project.
I believe these changes will greatly improve the readability and maintainability of the code. I look forward to your feedback.
Best regards,
Juan Pablo Cadena Aguilar