Correctly marked
.xhr(options, callback) where callback arguments are error and result ( xhr.responseXML or xhr.response).fetch(resource, options) where success is result or throws error.
Incorrectly marked
.authenticate(callback) where callback arguments should be marked as error and self..authenticateAsync() where success should be marked as self or throws error..bootstrapToken(auth_code, callback) where callback arguments should be marked as error and self.
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.
Correctly marked
.xhr(options, callback)wherecallbackarguments areerrorandresult(xhr.responseXMLorxhr.response).fetch(resource, options)where success isresultor throwserror.Incorrectly marked
.authenticate(callback)wherecallbackarguments should be marked aserrorandself..authenticateAsync()where success should be marked asselfor throwserror..bootstrapToken(auth_code, callback)wherecallbackarguments should be marked aserrorandself.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 asself, and when it returns a request result, it should be written asresult. This is clear, sensible, and lucid.