Improve: Optimize the documentation of Egg Catcher project #283
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
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
<282>
Type of change
Choosing one or more options from the following as per the nature of your Pull request.
Project
Project Name:Egg Catcher
Checklist:
Please tick all the boxes that are fulfilled by your Pull Request.
README.md
, according to the givenREADME_TEMPLATE.