Docs: add documentation for Linter methods (refs #6525) #9151
Conversation
This file contains 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
|
LGTM |
|
@not-an-aardvark, thanks for your PR! By analyzing the history of the files in this pull request, we identified @nzakas, @gyandeeps and @SimenB to be potential reviewers. |
platinumazure
approved these changes
Aug 24, 2017
btmills
added a commit
that referenced
this pull request
Sep 15, 2017
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What is the purpose of this pull request? (put an "X" next to item)
[x] Documentation update
What changes did you make? (Give an overview)
This adds documentation for the new APIs that were added in #6525, as well as a few other
Lintermethods that are undocumented.The other methods on
Linter.prototype(reset,report,getSourceCode,getAncestors,getScope,markVariableAsUsed,getFilename,defaults,getDeclaredVariables, the external methods here, and the methods onEventEmitter.prototype) are not intended to be used by Node.js API users, and are only exposed incidentally, so I didn't document them. Eventually I'd like to remove them and/or rename them to make it clear that they're private. It would also be nice to keeplinter.verifyas a pure function, but it currently modifies some internal state which is visible through those private methods.Is there anything you'd like reviewers to focus on?
Nothing in particular