From bf54dda9647ea2dbb57a7eadb425259a8f8c1229 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20T=C3=B6tterman?= Date: Fri, 27 Oct 2017 08:13:47 +0200 Subject: [PATCH] changes after review --- CONTRIBUTING.md | 14 +------------- USAGE.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d471a1..0a7ffa9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,18 +120,6 @@ Run the test: `mocha` - ### Documentation - - If you would like to auto-generate documentation of the packages, you can do so locally by running: - - `./node_modules/.bin/esdoc` - - Using the .esdoc.json file, esdoc will create documentation in the docs directory. - - ### Checking docs coverage - - 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. - ## Style Guidelines & Naming Conventions @@ -142,7 +130,7 @@ Generally, we follow the style guidelines as suggested by the official language. Please run your code through: - [ESLint](http://eslint.org/) with the standard style guide. -- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#testing) to check the documentation coverage of your added code. +- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/USAGE.md) to check the documentation coverage of your added code. ## Creating a Pull Request diff --git a/USAGE.md b/USAGE.md index 2807aa9..51aaa9d 100644 --- a/USAGE.md +++ b/USAGE.md @@ -15,3 +15,15 @@ To run the example: ```bash node examples/example ``` + + # Documentation + + If you would like to auto-generate documentation of the packages, you can do so locally by running: + + `./node_modules/.bin/esdoc` + + Using the .esdoc.json file, esdoc will create documentation in the docs directory. + + ## Checking docs coverage + + 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. \ No newline at end of file