Skip to content

Commit

Permalink
Merge pull request #819 from vrubiolo/docfix
Browse files Browse the repository at this point in the history
Motor doc: fix wrong comment
  • Loading branch information
rwaldron committed Jun 3, 2015
2 parents d41d39e + a597b9d commit 83d03e1
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


<a name="sample-projects"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/motor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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");
});
Expand Down
2 changes: 1 addition & 1 deletion eg/motor.js
Original file line number Diff line number Diff line change
Expand Up @@ -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");
});
Expand Down

0 comments on commit 83d03e1

Please sign in to comment.