Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs + clean up pagination code + a bunch of minor changes #44

Merged
merged 12 commits into from
Dec 2, 2015

Conversation

jrevels
Copy link
Member

@jrevels jrevels commented Dec 1, 2015

This is another PR that's crammed with way too much stuff - apologies again. I promise I'll be more orderly moving forward, I just really want to get this merged so we can finally tag a new version.

This PR:

  • provides documentation for basically every user-facing part of the package
  • simplifies the pagination code, and causes paginated methods to return page metadata so that the user can more easily configure subsequent calls (this is explained in the new docs if you want to read more about it)
  • adds a few more REST methods (mainly comment-related functionality)
  • removes BasicAuth, which didn't work for authentication in the first place

As for bumping the version number after this PR is merged, I'm not sure whether I should raise the major number or the minor number. There are obviously a bunch of breaking changes since the previous version of the package, and the design has been altered quite a bit.

@WestleyArgentum
Copy link
Collaborator

Wow, haven't looked super deep, but this seems like really good stuff.

Re versioning: I'd vote for bumping the major version.

Thanks for putting all this time in, really impressive work.

jrevels added a commit that referenced this pull request Dec 2, 2015
docs + clean up pagination code + a bunch of minor changes
@jrevels jrevels merged commit 168393d into master Dec 2, 2015
@jrevels jrevels deleted the partial-docs branch December 2, 2015 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants