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

Properly comment critical part #28

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

Conversation

amigrave
Copy link

Once the module will be more elaborated we will forget about the critical parts.

It is very important to keep track of what is doing what otherwise we won't remember what is true of false.

Please take your time to consider this pull request, we can discuss the comment style of course.

@mde
Copy link
Owner

mde commented Nov 6, 2021

Commenting style is critical here. I'm not a fan of same-line comments, because when the line of code gets longer, it gets too wide to display in splits in my text editor. I recognized the importance of this PR though, so if you would consider moving the comment to its own line, I'd be thrilled to merge it. Our open-source community is so lucky to have such dedicated contributors.

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