python-mini-project
python-mini-project copied to clipboard
Improve: Optimize the documentation of Egg Catcher project
Description
For this pull request I want to solve the issue_282, improving the code, so for example in this case I separate the code into two classes one for the logic and other for the design, with separation I wanted to improve the project's maintainability, so with this will be better for future developers that want to work in the project, also I added the docstrings for the functions to have a well-documented and I updated the README file to reflect these changes.
A short summary of what is included in your Pull Request.
Fixes #282
- [x] Issue_no:
<282>
- [ ] Not applicable
Type of change
Choosing one or more options from the following as per the nature of your Pull request.
- [ ] New project insert
- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [x] Documentation Update
Project
-
Project Name:Egg Catcher
Checklist:
Please tick all the boxes that are fulfilled by your Pull Request.
- [ ] I have named my files and folder, according to this project's guidelines.
- [ ] My code follows the style guidelines of this project.
- [x] I have commented on my code, particularly in hard-to-understand areas.
- [x] I have created a helpful and easy to understand
README.md
, according to the givenREADME_TEMPLATE.
- [ ] My changes do not produce any warnings.