diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6286a441a..c4a1c605f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,7 +85,7 @@ Docs should have tested and working sample code, [fritzing diagrams](http://frit The [wiki](https://github.com/rwaldron/johnny-five/wiki) contains documentation about the api, and contains code examples and fritzing diagrams. -The [eg folder](https://github.com/rwaldron/johnny-five/tree/master/eg) contains working code examples that users can run out of the box. Each of these example files has an associated .md file in the [docs folder](https://github.com/rwaldron/johnny-five/tree/master/docs) that is generated from the eg files. +The [eg folder](https://github.com/rwaldron/johnny-five/tree/master/eg) contains working code examples that users can run out of the box. Each of these example files has an associated .md file in the [docs folder](https://github.com/rwaldron/johnny-five/tree/master/docs) that is generated from the eg files. When contributing documentation updates for those code examples, modify the one in the [eg folder](https://github.com/rwaldron/johnny-five/tree/master/eg) and run `grunt examples` to regenerate its [docs folder](https://github.com/rwaldron/johnny-five/tree/master/docs) counterpart, then submit both of them as part of your contribution/PR. If you add a new documentation file, remember you will need to add it to `tpl/program.json` as well. diff --git a/docs/motor.md b/docs/motor.md index 9befe9d51..f66d20703 100644 --- a/docs/motor.md +++ b/docs/motor.md @@ -42,7 +42,7 @@ board.on("ready", function() { }); }); - // "stop" events fire when the motor is started. + // "stop" events fire when the motor is stopped. motor.on("stop", function() { console.log("stop"); }); diff --git a/eg/motor.js b/eg/motor.js index 3b4d32281..7c5c616e2 100644 --- a/eg/motor.js +++ b/eg/motor.js @@ -28,7 +28,7 @@ board.on("ready", function() { }); }); - // "stop" events fire when the motor is started. + // "stop" events fire when the motor is stopped. motor.on("stop", function() { console.log("stop"); });