Skip to content
This repository was archived by the owner on Aug 20, 2020. It is now read-only.

Commit bf54dda

Browse files
committed
changes after review
1 parent 8a8b78c commit bf54dda

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -120,18 +120,6 @@ Run the test:
120120

121121
`mocha`
122122

123-
### Documentation
124-
125-
If you would like to auto-generate documentation of the packages, you can do so locally by running:
126-
127-
`./node_modules/.bin/esdoc`
128-
129-
Using the .esdoc.json file, esdoc will create documentation in the docs directory.
130-
131-
### Checking docs coverage
132-
133-
You will find a coverage.json file in the **docs** directory. This will contain information about the documentation coverage for each of the different files in this repo.
134-
135123
<a name="style-guidelines-and-naming-conventions"></a>
136124
## Style Guidelines & Naming Conventions
137125

@@ -142,7 +130,7 @@ Generally, we follow the style guidelines as suggested by the official language.
142130
Please run your code through:
143131

144132
- [ESLint](http://eslint.org/) with the standard style guide.
145-
- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#testing) to check the documentation coverage of your added code.
133+
- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/USAGE.md) to check the documentation coverage of your added code.
146134

147135
<a name="creating-a-pull-request"></a>
148136
## Creating a Pull Request

USAGE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,15 @@ To run the example:
1515
```bash
1616
node examples/example
1717
```
18+
19+
# Documentation
20+
21+
If you would like to auto-generate documentation of the packages, you can do so locally by running:
22+
23+
`./node_modules/.bin/esdoc`
24+
25+
Using the .esdoc.json file, esdoc will create documentation in the docs directory.
26+
27+
## Checking docs coverage
28+
29+
You will find a coverage.json file in the **docs** directory. This will contain information about the documentation coverage for each of the different files in this repo.

0 commit comments

Comments
 (0)