This pull request updates the docstrings and documentation for the Chess Game project, to ensure that all methods are well-documented and easy to understand. And for the Readme file I updated it with the Game instruction, features and the information of the classes and methods.
A short summary of what is included in your Pull Request.
Fixes #275
[x] Issue_no: <275>
[ ] 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)
[ ] New feature (non-breaking change which adds functionality)
[x] Documentation Update
Project
Project Name: Chess Game
Short Description: Provide a short desctiption of your Python project
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 given README_TEMPLATE.
Description
This pull request updates the docstrings and documentation for the Chess Game project, to ensure that all methods are well-documented and easy to understand. And for the Readme file I updated it with the Game instruction, features and the information of the classes and methods.
A short summary of what is included in your Pull Request.
Fixes #275
<275>
Type of change
Choosing one or more options from the following as per the nature of your Pull request.
Project
Project Name: Chess Game
Short Description: Provide a short desctiption of your Python project
Checklist:
Please tick all the boxes that are fulfilled by your Pull Request.
README.md
, according to the givenREADME_TEMPLATE.