You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by lo...@apache.org on 2014/08/14 22:21:06 UTC
git commit: [CB-7313] minor tweak to documentation of
watchAcceleration function parameters
Repository: cordova-plugin-device-motion
Updated Branches:
refs/heads/master cf0600859 -> ad94eecd3
[CB-7313] minor tweak to documentation of watchAcceleration function parameters
accelerometerOptions is an object with a single optional key, now documented as such
changed frequency to period, as it is the period that is being specified, not frequency.
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion/commit/ad94eecd
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion/tree/ad94eecd
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion/diff/ad94eecd
Branch: refs/heads/master
Commit: ad94eecd30a89c6746ce100a09040aad344a89ec
Parents: cf06008
Author: Lorin Beer <lo...@gmail.com>
Authored: Thu Aug 14 13:20:52 2014 -0700
Committer: Lorin Beer <lo...@gmail.com>
Committed: Thu Aug 14 13:20:52 2014 -0700
----------------------------------------------------------------------
doc/index.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion/blob/ad94eecd/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
index d0f5127..e44ddaf 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -94,10 +94,10 @@ accelerometer.
var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
accelerometerError,
- [accelerometerOptions]);
+ accelerometerOptions);
- __accelerometerOptions__: An object with the following optional keys:
- - __frequency__: How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
+ - __period__: requested period of calls to accelerometerSuccess with acceleration data in Milliseconds. _(Number)_ (Default: 10000)
### Example