CB-13693: Improves Documentation (#162)
authorDanWithams7d <dan@7d-digital.co.uk>
Wed, 20 Dec 2017 16:50:04 +0000 (16:50 +0000)
committerJan Piotrowski <piotrowski+github@gmail.com>
Wed, 20 Dec 2017 16:50:04 +0000 (17:50 +0100)
The explanation of the contactFields argument in the 'navigator.contacts.find' section is unclear and ambiguous. Updating to make it clearer to people wanting to utilise this plugin.

README.md
types/index.d.ts

index 454a028..3e7520a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -165,10 +165,10 @@ device contacts database and returning an array of `Contact` objects.
 The resulting objects are passed to the `contactSuccess` callback
 function specified by the __contactSuccess__ parameter.
 
-The __contactFields__ parameter specifies the fields to be used as a
-search qualifier.  A zero-length __contactFields__ parameter is invalid and results in
-`ContactError.INVALID_ARGUMENT_ERROR`. A __contactFields__ value of
-`"*"` searches all contact fields.
+The __contactFields__ parameter should always be an array and specifies the
+fields to be used as a search qualifier.  A zero-length __contactFields__
+parameter is invalid and results in `ContactError.INVALID_ARGUMENT_ERROR`.
+A __contactFields__ value of `["*"]` searches all contact fields.
 
 The __contactFindOptions.filter__ string can be used as a search
 filter when querying the contacts database.  If provided, a
index f0979ba..3812c70 100644 (file)
@@ -23,9 +23,9 @@ interface Contacts {
      * The navigator.contacts.find method executes asynchronously, querying the device contacts database
      * and returning an array of Contact objects. The resulting objects are passed to the onSuccess
      * callback function specified by the onSuccess parameter.
-     * @param fields The fields parameter specifies the fields to be used as a search qualifier,
-     * and only those results are passed to the onSuccess callback function. A zero-length fields parameter
-     * is invalid and results in ContactError.INVALID_ARGUMENT_ERROR. A contactFields value of "*" returns all contact fields.
+     * @param fields The fields parameter should always be an array and specifies the fields to be used
+     * as a search qualifier.  A zero-length fields parameter is invalid and results in ContactError.INVALID_ARGUMENT_ERROR.
+     * A fields value of ["*"] searches all contact fields.
      * @param onSuccess Success callback function invoked with the array of Contact objects returned from the database
      * @param onError Error callback function, invoked when an error occurs.
      * @param options Search options to filter navigator.contacts.