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

Addition of comments for readability #11

Closed
wants to merge 2 commits into from
Closed

Conversation

neyjay12
Copy link

I went through the code and i added comments to make the code more readable and to be more transparent please let me know if i did anything wrong

I made more comments to what I understand on the code to make the code to make it more readable
@reynir
Copy link
Owner

reynir commented Mar 31, 2023

Your PR includes #10 which I will not comment on here.

The comments are almost all misleading or wrong. The exceptions are for is_within, read and write. I am not convinced they contribute much towards better readability and transparency.

@reynir reynir closed this Mar 31, 2023
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.

None yet

2 participants