docs: comment code better to help contributors#437
Merged
Conversation
|
|
||
| // Extract docs from shell.js | ||
| var docs = grep('//@', 'shell.js'); | ||
| var docs = grep('^//@', 'shell.js'); |
Member
Author
There was a problem hiding this comment.
This makes the regex a bit more specific than what it was before. This lets us have comments like what we see in shell.js line 30:
// The //@include includes the docs for that commandOtherwise, this would attempt to include docs from a file named includes the docs for that command.js (which obviously doesn't exist).
Member
Author
|
@ariporad Let me know if anything here should be changed/updated |
shell.js
Outdated
|
|
||
| //@include ./src/sed | ||
| var _sed = require('./src/sed'); | ||
| var _sed = require('./src/sed'); // don't glob-expand regexes |
Contributor
There was a problem hiding this comment.
Shouldn't the // don't glob-expand regexes be on the line below?
Member
Author
There was a problem hiding this comment.
Good point. I think I put it there just because the line was getting long, but I agree it makes more sense as you suggested.
| } else { // and this branch is for everything else | ||
| if (args[0] instanceof Object && args[0].constructor.name === 'Object') { | ||
| args = args; // object count as options | ||
| // a no-op, allowing the syntax `touch({'-r': file}, ...)` |
Member
Author
There was a problem hiding this comment.
@ariporad is this different from what you had in mind?
Contributor
|
LGTM |
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
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.
I realized that our code base can be somewhat confusing in key areas. This should help clarify some of the more confusing parts for other contributors.