Skip to content

[DOC] Invalid description of API #133

@gander

Description

@gander

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions