generate API documentation #3239
Closed
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
|
Thanks. @dfberry |
boneskull
suggested changes
Feb 28, 2018
There was a problem hiding this comment.
this is awesome, thanks.
- Can we generate HTML docs instead?
- lint
package-scripts.js
I'm not really happy with how everything hangs off of the base Mocha namespace, but I'd have to play with documentation a bit more to understand the best way to use docstrings to get it looking like how I envisioned. Regardless, that shouldn't hold up merging this.
boneskull
added
the
semver-patch
* origin/master: (58 commits) Tap reporter: report thrown error messages (#3317) fix circular objects in json reporter; closes #2433 (#3318) fix wrong version in package.json! [ci skip] doc precision for exclusive tests optimize package-scripts.js PATH workaround for Travis CI bug further build improvements (#3315) update package-lock.json for v5.0.5 [ci skip] improve caching performance in CI (#3310) update stages and build matrices (#3308) add update-contributors script; closes #3289 (#3290) upgrade eslint; lint use build stages for Travis CI (#3302) use exact version of minimatch [ci skip] remove 0-byte file [ci skip] Refactor Reporter tests (#3272) #1577 Add "--exclude" Option (#3210) Release v5.0.5 add changes for v5.0.5 [ci skip] remove default js in "--watch-extensions" option; closes #3275 ...
Munter
pushed a commit
that referenced
this pull request
Apr 12, 2018
Fixes #3138 Replaces and closes #3239 basically working Suite and utils work Runner and Suite datatypes work Hook extends Runnable - at least link in description hook is child of mocha and has error first solid pass Remove attempted module link from Hook to Runnable because of documentationjs/documentation#820 Switch API documenation to html output, link to them, include in site build Update TOC Bring lock file in sync with package.json Linting Update package-lock.json
Munter
pushed a commit
that referenced
this pull request
Apr 12, 2018
Fixes #3138 Replaces and closes #3239 basically working Suite and utils work Runner and Suite datatypes work Hook extends Runnable - at least link in description hook is child of mocha and has error first solid pass Remove attempted module link from Hook to Runnable because of documentationjs/documentation#820 Switch API documenation to html output, link to them, include in site build Update TOC Bring lock file in sync with package.json Linting Update package-lock.json
boneskull
pushed a commit
that referenced
this pull request
Apr 12, 2018
Fixes #3138 Replaces and closes #3239 basically working Suite and utils work Runner and Suite datatypes work Hook extends Runnable - at least link in description hook is child of mocha and has error first solid pass Remove attempted module link from Hook to Runnable because of documentationjs/documentation#820 Switch API documenation to html output, link to them, include in site build Update TOC Bring lock file in sync with package.json Linting Update package-lock.json
sgilroy
pushed a commit
to TwineHealth/mocha
that referenced
this pull request
Feb 27, 2019
Fixes mochajs#3138 Replaces and closes mochajs#3239 basically working Suite and utils work Runner and Suite datatypes work Hook extends Runnable - at least link in description hook is child of mocha and has error first solid pass Remove attempted module link from Hook to Runnable because of documentationjs/documentation#820 Switch API documenation to html output, link to them, include in site build Update TOC Bring lock file in sync with package.json Linting Update package-lock.json
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.
Changes in jsdocs comments only in order to product api docs.
Description of the Change
changes to get markdown for api docs using documentation.js
Alternate Designs
The current code exports, inherits, and layers make jsdocs a bit of a mash up. There are some errors here but I'm not sure if the easier fix is jsdocs annotations or code changes.
Why should this be in core?
Shows APIs
Benefits
Better communication for API usage.
Possible Drawbacks
Some assumptions are made about inheritance and relationships. I may have left things off or added things that should be there.
Applicable issues
I need to understand how jsdocs is built by documentationjs to resolve some of the existing issues.