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.

Sign up for GitHub

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

Jump to bottom

Replace documentation with jsdoc with mocha flavor #3328

Merged
merged 6 commits into from
Apr 21, 2018
Merged

Replace documentation with jsdoc with mocha flavor #3328

merged 6 commits into from
Apr 21, 2018

Conversation

Munter
Copy link
Contributor

@Munter Munter commented Apr 14, 2018

Switched api docs generation from documentation to jsdoc with the new mocha-docdash theme applied.

Also removed a bunch of error inducing comments in a lot o files.

The jsdoc output it not entirely useful yet, but more than the documentation output was.

There's still some work needed to get the jsdoc comments to actually produce really good output

@Munter Munter requested a review from boneskull April 14, 2018 22:18
outsideris
outsideris approved these changes Apr 15, 2018
View reviewed changes
Copy link
Contributor

@outsideris outsideris left a comment

Choose a reason for hiding this comment

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

Awesome!!

boneskull
boneskull approved these changes Apr 16, 2018
View reviewed changes
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.

mad and sick

please update with @mocha/docdash and merge!

@outsideris outsideris added the area: documentation anything involving docs or mochajs.org label Apr 19, 2018
@boneskull
Copy link
Contributor

boneskull commented Apr 21, 2018 •
edited
Loading

I rebased all this crap onto master, updated the template package to @mocha/docdash and added docs/API.md. see result (or just append /api/ to the netlify preview URL)

oh, and added @mocha/docdash to Travis CI

@coveralls
Copy link

Coverage Status

Coverage remained the same at 90.009% when pulling 4cdd671 on jsdoc into 3a65a64 on master.

@Munter Munter merged commit efff26f into master Apr 21, 2018
@Munter Munter deleted the jsdoc branch April 21, 2018 14:24
@boneskull boneskull added this to the next milestone May 17, 2018
@dependencies dependencies bot mentioned this pull request May 19, 2018
Closed
wopian referenced this pull request in wopian/agc-assembly May 20, 2018
@renovate @wopian
chore(deps): update dependency mocha to ~5.2.0 (#116)
cd35efb 
This Pull Request updates dependency [mocha](https://github.com/mochajs/mocha) from `~5.1.0` to `~5.2.0`



<details>
<summary>Release Notes</summary>

### [`v5.2.0`](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md#&#8203;520--2018-05-18)
[Compare Source](mochajs/mocha@v5.1.1...v5.2.0)
#### 🎉 Enhancements

- [#&#8203;3375]: Add support for comments in `mocha.opts` ([@&#8203;plroebuck])
#### 🐛 Fixes

- [#&#8203;3346]: Exit correctly from `before` hooks when using `--bail` ([@&#8203;outsideris])
#### 📖 Documentation

- [#&#8203;3328]: Mocha-flavored [API docs](https://mochajs.org/api/)! ([@&#8203;Munter])
#### 🔩 Other

- [#&#8203;3330]: Use `Buffer.from()` ([@&#8203;harrysarson])
- [#&#8203;3295]: Remove redundant folder ([@&#8203;DavNej])
- [#&#8203;3356](`https://github.com/mochajs/mocha/pull/3356`): Refactoring ([@&#8203;plroebuck])

[#&#8203;3375]: `https://github.com/mochajs/mocha/pull/3375`
[#&#8203;3346]: `https://github.com/mochajs/mocha/pull/3346`
[#&#8203;3328]: `https://github.com/mochajs/mocha/pull/3328`
[#&#8203;3330]: `https://github.com/mochajs/mocha/pull/3330`
[#&#8203;3295]: `https://github.com/mochajs/mocha/pull/3295`

[@&#8203;plroebuck]: https://github.com/plroebuck
[@&#8203;harrysarson]: https://github.com/harrysarson
[@&#8203;outsideris]: https://github.com/outsideris
[@&#8203;Munter]: https://github.com/Munter

---

</details>




---

This PR has been generated by [Renovate Bot](https://renovatebot.com).
This was referenced Sep 22, 2018
Closed
Closed
Closed
Merged
Open
Merged
Open
Closed
Closed
Closed
Merged
This was referenced Oct 5, 2018
Open
Merged
This was referenced Oct 25, 2018
Merged
Merged
Closed
Closed
This was referenced Nov 1, 2018
Merged
Merged
Merged
This was referenced Nov 9, 2018
Merged
Closed
Closed
Merged
Merged
This was referenced Nov 17, 2018
Merged
Closed
Merged
This was referenced Dec 1, 2018
Closed
Merged
Merged
This was referenced Dec 8, 2018
Merged
Closed
Merged
Closed
This was referenced Dec 23, 2018
Closed
Closed
This was referenced Mar 14, 2020
Closed
Closed
Closed
@satoshinakamoto007 satoshinakamoto007 mentioned this pull request Sep 9, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@boneskull boneskull boneskull approved these changes

@outsideris outsideris outsideris approved these changes

Assignees
No one assigned
Labels
area: documentation anything involving docs or mochajs.org
Projects
None yet
Milestone
v5.2.0
Development

Successfully merging this pull request may close these issues.
4 participants
@Munter @boneskull @coveralls @outsideris