Skip to content

Commit

Permalink
add missing parenthesis
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasCARPi committed Jul 31, 2020
1 parent d194f2e commit c6e91f8
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ $ $BROWSER /tmp/doc

### Programmatic usage

You can generate the documentation programmatically.
You can generate the documentation programmatically:

```ts
import path from 'path'
Expand All @@ -64,13 +64,12 @@ const doc = createDoc({

if (typeof doc !== 'boolean') {
// Documentation was generated!

console.log(doc.data) // `api_data.json` file content
console.log(doc.project) // `api_project.json` file content
}
```

Install type definitions (see [@types/apidoc](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/apidoc/index.d.ts):
Install type definitions (see [@types/apidoc](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/apidoc/index.d.ts)):

```bash
$ npm install -D @types/apidoc
Expand Down

0 comments on commit c6e91f8

Please sign in to comment.