Skip to content

Commit

Permalink
Tidying up a method comment
Browse files Browse the repository at this point in the history
  • Loading branch information
ciaranj committed Aug 17, 2011
1 parent aca047e commit 85805b6
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions lib/oauth.js
Original file line number Diff line number Diff line change
Expand Up @@ -485,14 +485,17 @@ exports.OAuth.prototype.post= function(url, oauth_token, oauth_token_secret, pos
*
* function(err, token, token_secret, parsedQueryString) {}
*
* This method has optional parameters so can be called in the following 3 ways:
* This method has optional parameters so can be called in the following 2 ways:
*
* 1) Primary use case: Does a basic request with no extra parameters, using a POST
* 1) Primary use case: Does a basic request with no extra parameters
* getOAuthRequestToken( callbackFunction )
*
* 2) As above but allows for provision of extra parameters to be sent as part of the query to the server (POST).
* 2) As above but allows for provision of extra parameters to be sent as part of the query to the server.
* getOAuthRequestToken( extraParams, callbackFunction )
*
* N.B. This method will HTTP POST verbs by default, if you wish to override this behaviour you will
* need to provide a requestTokenHttpMethod option when creating the client.
*
**/
exports.OAuth.prototype.getOAuthRequestToken= function( extraParams, callback ) {
if( typeof extraParams == "function" ){
Expand Down

0 comments on commit 85805b6

Please sign in to comment.