search

kentcdodds / nps-utils

Utilities for http://npm.im/nps (npm-package-scripts)
https://doclets.io/kentcdodds/nps-utils/master
MIT License
101 stars 23 forks source link

Fix readme #14

Closed huy-nguyen closed 7 years ago

huy-nguyen commented 7 years ago

Fix a typo in README.

codecov-io commented 7 years ago

Codecov Report

Merging #14 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #14   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           1      1           
  Lines          60     60           
=====================================
  Hits           60     60

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update bd63657...53c755a. Read the comment docs.

huy-nguyen commented 7 years ago

I think the problem is actually with the JSDoc parser that doclets use, more specifically with the ES6 syntax used in the file. I tried jsdoc parser on src/index.js but it failed because of a closing parenthesis. I then tried esdoc which can understand ES6 syntax and it was able to generate the doc beautifully.

Coincidentally, esdoc is also what RxJS uses for their online documentation. They also offer free documentation hosting. Do you want to explore this further?

screen shot 2017-04-27 at 12 09 51 am

kentcdodds commented 7 years ago

Oh, that's super awesome. Yes, I definitely want to give it a try!