[CB-13693] Improvement to apache/cordova-plugin-contacts documentation

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Component/s: cordova-plugin-contacts (DEPRECATED)
• Labels: documentation
• Assignee: Unassigned
• Reporter: Daniel Withams
• Created: 20/Dec/17 10:48
• Updated: 23/Aug/18 06:45
• Resolved: 20/Dec/17 17:04

Description

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.

1) At no point is the argument data type described (array0
2) The statement for using "*" to search all fields is ambiguous due to a combination of point 1) and direct ambiguity in the statement itself (the description of the value of the argument by providing a STRING example rather than an ARRAY example.

Issue Links

• links to: GitHub Pull Request #161
• links to: GitHub Pull Request #162