Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement API documentation using npm:documentation. #3323

Merged
merged 1 commit into from
Apr 12, 2018
Merged

Conversation

Munter
Copy link
Contributor

@Munter Munter commented Apr 12, 2018

Auto generated API documentation using https://www.npmjs.com/package/documentation

This PR is a rebased and squashed version of #3239 by @dfberry

@boneskull's reservations about html generation and linting have been addressed

Fixes #3138
Replaces and closes #3239

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 Munter requested a review from boneskull April 12, 2018 20:57
Copy link
Contributor

@boneskull boneskull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM unless you want to remove @api from everywhere

* @public
* @class JSON
* @memberof Mocha.reporters
* @extends Mocha.reporters.Base
* @api public
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are welcome to remove @api public and @api private from everywhere if you wish.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 90.009% when pulling fefa339 on issue/3138 into 1acea30 on master.

@boneskull boneskull added area: documentation anything involving docs or mochajs.org semver-patch implementation requires increase of "patch" version number; "bug fixes" labels Apr 12, 2018
@Munter Munter merged commit 2f48a23 into master Apr 12, 2018
@Munter Munter deleted the issue/3138 branch April 12, 2018 21:37
@boneskull boneskull added this to the v5.1.0 milestone Apr 12, 2018
This was referenced Sep 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation anything involving docs or mochajs.org semver-patch implementation requires increase of "patch" version number; "bug fixes"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update Programmatic API documentation
4 participants