Move API docs to its own file #296
Merged
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
docs/api.md
Outdated
Contributor
There was a problem hiding this comment.
The callback receives an array, since 5.0.0. (I guess I missed updating something in the readme back when I did #88?)
Member
Author
There was a problem hiding this comment.
What does the callback function signature look like?
Contributor
There was a problem hiding this comment.
It's still error-object-first, it's just (err, appPaths) now rather than singular appPath.
malept
force-pushed
the
separate-api-docs
branch
from
58a0ca0 to
68413f8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 cleaned up the headers, added some intra-doc links, and changed some formatting. I think it looks better, overall. And, you can now link to a specific option.
Fixes #275.
(Clicking "View" is probably a better way of looking at it, rather than the diff.)
TODO