ndleah / python-mini-project

🙌 Welcome open-source Python mini-project contributions!
MIT License
3.17k stars 1.25k forks source link

Improve: Optimize the documentation of Egg Catcher project #283

Open Gabriela20103967 opened 5 months ago

Gabriela20103967 commented 5 months ago

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

Type of change

Choosing one or more options from the following as per the nature of your Pull request.

Project

Checklist:

Please tick all the boxes that are fulfilled by your Pull Request.