[
https://issues.apache.org/jira/browse/CB-13693?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16298542#comment-16298542
]
ASF GitHub Bot commented on CB-13693:
-------------------------------------
DanWithams7d opened a new pull request #162: CB-13693: Improves Documentation
URL: https://github.com/apache/cordova-plugin-contacts/pull/162
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 (array)
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.
<!--
Please make sure the checklist boxes are all checked before submitting the
PR. The checklist
is intended as a quick reference, for complete details please see our
Contributor Guidelines:
http://cordova.apache.org/contribute/contribute_guidelines.html
Thanks!
-->
### Platforms affected
None
### What does this PR do?
Improves documentation
### What testing has been done on this change?
Not applicable
### Checklist
- [Y] [Reported an issue](http://cordova.apache.org/contribute/issues.html)
in the JIRA database
- [Y] Commit message follows the format: "CB-3232: (android) Fix bug with
resolving file paths", where CB-xxxx is the JIRA ID & "android" is the platform
affected.
- [Y] Added automated test coverage as appropriate for this change.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Improvement to apache/cordova-plugin-contacts documentation
> -----------------------------------------------------------
>
> Key: CB-13693
> URL: https://issues.apache.org/jira/browse/CB-13693
> Project: Apache Cordova
> Issue Type: Improvement
> Components: cordova-plugin-contacts (DEPRECATED)
> Reporter: Daniel Withams
> Priority: Minor
> Labels: documentation
> Original Estimate: 5m
> Remaining Estimate: 5m
>
> 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.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
