mde / true

A JavaScript port of the Unix utility 'true'. Returns the Boolean value `true`
101 stars 26 forks source link

Properly comment critical part #28

Open amigrave opened 3 years ago

amigrave commented 3 years ago

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 commented 3 years ago

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.