[
https://issues.apache.org/jira/browse/CB-7313?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14097573#comment-14097573
]
ASF subversion and git services commented on CB-7313:
-----------------------------------------------------
Commit ad94eecd30a89c6746ce100a09040aad344a89ec in
cordova-plugin-device-motion's branch refs/heads/master from [~lorin]
[
https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-device-motion.git;h=ad94eec
]
[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.
> Misleading documentation in Device Motion Plugin
> ------------------------------------------------
>
> Key: CB-7313
> URL: https://issues.apache.org/jira/browse/CB-7313
> Project: Apache Cordova
> Issue Type: Bug
> Components: Plugin Device Motion
> Reporter: Lorin Beer
> Assignee: Lorin Beer
> Priority: Minor
>
> device motion documentation reads
> {code}
> The returned watch ID references the accelerometer's watch interval, and can
> be used with navigator.accelerometer.clearWatch to stop watching the
> accelerometer.
> var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
> accelerometerError,
>
> [accelerometerOptions]);
> {code}
> last line indicates an array is the expected argument, which causes the api
> to return an error
> it should read
> {code}
> accelerometerOptions);
> {code}
> the rest of watchAccel correctly documents accelerometerOptions as an object.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
