[GitHub] jthomas commented on a change in pull request #63: style: add .editorconfig, eslint and reformat js file

[GitBox <gi...@apache.org>]

jthomas commented on a change in pull request #63: style: add .editorconfig, eslint and reformat js file
URL: https://github.com/apache/incubator-openwhisk-client-js/pull/63#discussion_r150490363
 
 

 ##########
 File path: README.md
 ##########
 @@ -66,19 +67,19 @@ ow.actions.invoke('sample').then(result => console.log(result))
 _Client constructor supports the following mandatory parameters:_
 
 - **apihost.** Hostname and optional port for openwhisk platform, e.g. `openwhisk.ng.bluemix.net` or `my_whisk_host:80`. Used with API URL template `${protocol}://${apihost}/api/v1/`. If port is missing or port value is 443 in the apihost string, protocol is HTTPS. Otherwise, protocol is HTTP.
-- **api_key.** Authorisation key for user account registered with OpenWhisk platform.
+- **apiKey.** Authorisation key for user account registered with OpenWhisk platform.
 
 Review comment:
   I don't think we should be marking the current parameters as `deprecated` to fit arbitrary style rules. Changing the internal code style is fine but doing this to the constructor parameters is unnecessary and confusing. I believe that underscores are more common in JavaScript-land and much less error-prone. It's very easy to miss a capitalisation when reading documentation. 

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services