Code review comment for lp://staging/~abreu-alexandre/unity-webapps-qml/fix-oa-docs

Revision history for this message
Kyle Nitzsche (knitzsche) wrote :

for every method that returns something, lets always start the description like this:
"Returns ...."

Not 'retrieves'. Not implied.

For example, this should be "Returns..."
        /**
         * Retrieves the account's numeric ID; note that all
>. * AccountService objects which work on the same online account will have the same ID.
         *
         * If the callback parameter is not set, the current "local" value is retrieved.
         *
         * @method accountId
         * @param callback (optional) {Function(String)}
         */
        accountId: function(callback) {

« Back to merge proposal