Add comments to make the codebase easier to understand #647
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
HexF
requested changes
Apr 18, 2024
Collaborator
HexF
left a comment
HexF
left a comment
There was a problem hiding this comment.
Overall great work! Love the comments, just a little unhappy with the removal of brackets.
Although it technically may evaluate out the same, brackets for code clarity can never hurt.
Thanks for these changes though!
| event_bus.emit('stderr', data); | ||
| } else if ((stderr.length + data.length) > this.runtime.output_max_size) { | ||
| } else if ( | ||
| stderr.length + data.length > |
Collaborator
There was a problem hiding this comment.
A little personal thing for me is putting expressions before comparing operators like this in brackets - in my mind it helps clear up order of operations.
| event_bus.emit('stdout', data); | ||
| } else if ((stdout.length + data.length) > this.runtime.output_max_size) { | ||
| } else if ( | ||
| stdout.length + data.length > |
Collaborator
There was a problem hiding this comment.
Same this as before with the brackets.
Author
There was a problem hiding this comment.
Thank for the review @HexF
The added curly braces must are unintended formatting mistake, I'll fix that
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.
used jsdoc to document the following files: