Mailing-List: contact dev-help@cordova.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@cordova.apache.org
From: clelland <git@git.apache.org>
To: dev@cordova.apache.org
Reply-To: dev@cordova.apache.org
References: <git-pr-21-cordova-plugin-camera@git.apache.org>
In-Reply-To: <git-pr-21-cordova-plugin-camera@git.apache.org>
Subject: [GitHub] cordova-plugin-camera pull request: Update index.md
Content-Type: text/plain
Message-Id: <20140331173714.E87C790885E@tyr.zones.apache.org>
Date: Mon, 31 Mar 2014 17:37:14 +0000 (UTC)

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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---