-
Notifications
You must be signed in to change notification settings - Fork 27
Open
Description
Correctly marked
.xhr(options, callback)
wherecallback
arguments areerror
andresult
(xhr.responseXML
orxhr.response
).fetch(resource, options)
where success isresult
or throwserror
.
Incorrectly marked
.authenticate(callback)
wherecallback
arguments should be marked aserror
andself
..authenticateAsync()
where success should be marked asself
or throwserror
..bootstrapToken(auth_code, callback)
wherecallback
arguments should be marked aserror
andself
.
Why?
In each of these functions success is marked as result
, however this is not true. This unsystematic nature complicates learning how to use the library. If a function returns self, it should be written as self
, and when it returns a request result, it should be written as result
. This is clear, sensible, and lucid.
Metadata
Metadata
Assignees
Labels
No labels