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

171 documentation become the comment master #193

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

Conversation

ymmot239
Copy link
Contributor

Documentation for most of the files.
Shouldn't have an effect on most of the running code, given they are mostly readability changes.

Commented all of the game and setup files, need to finish commenting the chessboard ones.
Completed the last of the chessboard and debug comments.
Completed common comments and fixed client comments
fun and interesting
Finished the comments for server folder.
Hopefully tcp-interface is clear and accurate enough
ran prettier on the changes
placeholder
finished all the inner comments for the client files
Added comments to needed files in common and server.
Also ran prettier for once
Filled in comments I missed in the first passes.
All files should now have some level of descriptive commenting.
@ymmot239 ymmot239 linked an issue Oct 25, 2024 that may be closed by this pull request
merged main into documentation and added appropriate comments
@democat3457
Copy link
Member

democat3457 commented Oct 29, 2024

Could you add spaces after all of the //? Also, several of these comments are incomplete.

as requested
Added clarification to some of the comments.
Merged in main and made comments on most of the new simulator code.
Should probably be reviewed by Jason for accuracy.
Added comments to the new merge for spectator fixes
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.

[Documentation]: Become the comment master!
2 participants