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

Comments #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Comments #3

wants to merge 1 commit into from

Conversation

SciXYolk
Copy link

@SciXYolk SciXYolk commented Jul 2, 2023

Commented on some of the classes.

Copy link
Owner

@F12-Syntex F12-Syntex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job, but some comments have no meaning like the chess pieces class comments

"This is a pawn class that extends chesspiece"

That doesn't really mean anything since a programmer can already see the class name and what it extends, instead talk about what the class will be used for and what it might relate to, for example

This is a class used to represent the attributes of a pawn piece in chess, used by the engine to render pawns onto the board

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.

2 participants