Properly comment critical part #28
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Owner
|
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
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.