Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance docstrings in the Chess Game project and Update the Readme file #276

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Gabriela20103967
Copy link

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

  • 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)
  • 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.
  • I have commented on my code, particularly in hard-to-understand areas.
  • I have created a helpful and easy to understand README.md, according to the given README_TEMPLATE.
  • My changes do not produce any warnings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Docstring and enhance readme file in Chess Game project
1 participant