Skip to content

Commit

Permalink
Better README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@oandregal
oandregal committed Jan 24, 2019
1 parent c91ca4e commit a5505cb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/docgen/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `docgen`

`docgen` helps you to generate the _public API_ of your code. Given an entry point file, it outputs the ES6 export statements in the file with their corresponding JSDoc comments in human-readable format.
`docgen` helps you to generate the _public API_ of your code. Given an entry point file, it outputs the ES6 export statements and their corresponding JSDoc comments in human-readable format.

Some characteristics:

Expand Down

0 comments on commit a5505cb

Please sign in to comment.