[GitHub] cordova-plugin-camera pull request: Update index.md

[Vic-thor]

GitHub user Vic-thor opened a pull request:

https://github.com/apache/cordova-plugin-camera/pull/150

Update index.md



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/Vic-thor/cordova-plugin-camera patch-1

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/cordova-plugin-camera/pull/150.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #150


commit 01445d33657a75de2cc8749877024b5c3fcd7f5a
Author: Vic-thor 
Date:   2016-01-11T10:31:48Z

Update index.md




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: dev-unsubscr...@cordova.apache.org
For additional commands, e-mail: dev-h...@cordova.apache.org

[GitHub] cordova-plugin-camera pull request: Update index.md

[Vic-thor]

Github user Vic-thor closed the pull request at:

https://github.com/apache/cordova-plugin-camera/pull/150


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

-
To unsubscribe, e-mail: dev-unsubscr...@cordova.apache.org
For additional commands, e-mail: dev-h...@cordova.apache.org

[GitHub] cordova-plugin-camera pull request: Update index.md

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/cordova-plugin-camera/pull/35


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] cordova-plugin-camera pull request: Update index.md

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/cordova-plugin-camera/pull/21


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] cordova-plugin-camera pull request: Update index.md

[cfjedimaster]

GitHub user cfjedimaster opened a pull request:

https://github.com/apache/cordova-plugin-camera/pull/35

Update index.md

I added some information about the defaults based on what I saw here: 
https://github.com/apache/cordova-plugin-camera/blob/master/www/Camera.js

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/cfjedimaster/cordova-plugin-camera patch-1

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/cordova-plugin-camera/pull/35.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #35


commit c07fb713cc3e951406a0802d1a842fd9231e3adf
Author: Raymond Camden raymondcam...@gmail.com
Date:   2014-06-20T17:34:24Z

Update index.md

I added some information about the defaults based on what I saw here: 
https://github.com/apache/cordova-plugin-camera/blob/master/www/Camera.js




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] cordova-plugin-camera pull request: Update index.md

[shazron]

Github user shazron commented on the pull request:


https://github.com/apache/cordova-plugin-camera/pull/21#issuecomment-40851591
  
Proper declaration notwithstanding, if it appears confusing to the user, 
then it has failed as documentation. What it needs here in this context, is a 
quick example usage accompanying this, or a header saying it's the signature. 
At the very least, something extra that clarifies this.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] cordova-plugin-camera pull request: Update index.md

[kieferhagin]

GitHub user kieferhagin opened a pull request:

https://github.com/apache/cordova-plugin-camera/pull/21

Update index.md

Using square brackets here insinuates that this function takes an array; in 
reality, it takes an object.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/kieferhagin/cordova-plugin-camera patch-1

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/cordova-plugin-camera/pull/21.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #21


commit c3462f6b0a3e380cff08643047d00074d4d6fa97
Author: kieferhagin kieferha...@gmail.com
Date:   2014-03-31T16:04:17Z

Update index.md

Using square brackets here insinuates that this function takes an array; in 
reality, it takes an object.




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] cordova-plugin-camera pull request: Update index.md

[clelland]

Github user clelland commented on the pull request:


https://github.com/apache/cordova-plugin-camera/pull/21#issuecomment-39111334
  
Square brackets are a pretty common notation for optional arguments -- I 
haven't checked to see whether we're using them that way consistently across 
plugins, but I'm pretty sure that's why they're there in the function signature 
in this case.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] cordova-plugin-camera pull request: Update index.md

[jsoref]

Github user jsoref commented on the pull request:


https://github.com/apache/cordova-plugin-camera/pull/21#issuecomment-39114920
  
Square brackets in JavaScript mean pass an array. While Square brackets 
in CMD make sense for optional, I wouldn't recommend that notation anywhere 
near JS.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] cordova-plugin-camera pull request: Update index.md

[clelland]

Github user clelland commented on the pull request:


https://github.com/apache/cordova-plugin-camera/pull/21#issuecomment-39117406
  
Not just shell commands; other languages with optional parameters use this 
notation as well.

When describing a function, I've seldom seen square brackets meaning An 
array goes here. Certainly in example code, or snippets that say things like

Call it like this: `foo(bar, baz, [item, item, ...])`,

but not when declaring the function signature.

My feeling is that square brackets are pretty universally used to mean 
optional, but more strongly than that, I think we'd need a good way to denote 
optionality if we drop them. Just dropping the square brackets and leaving the 
three arguments shown the same way is leaving out some of the most important 
information for a reader who wants to know how to call the function.



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] cordova-plugin-camera pull request: Update index.md

[clelland]

Github user clelland commented on the pull request:


https://github.com/apache/cordova-plugin-camera/pull/21#issuecomment-39117755
  
(BTW, please show me that I'm wrong here -- I feel much more strongly about 
clarity than about, say, a UNIX tradition. I'm happy to standardize on anything 
that's clear, succinct, and doesn't look like 
[IDL](http://www.w3.org/TR/WebIDL/))


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] cordova-plugin-camera pull request: Update index.md

[purplecabbage]

Github user purplecabbage commented on the pull request:


https://github.com/apache/cordova-plugin-camera/pull/21#issuecomment-39139828
  
I agree it's ugly, and confusing.
It should be made clearer that the line is NOT and example, but indeed a 
function signature.
Do we do this everywhere?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---