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

Add note on needing the Pagination plugin to use fetchPage() #1803

Merged
merged 1 commit into from Apr 3, 2018

Conversation

Projects
2 participants
@kevindong
Copy link
Contributor

kevindong commented Apr 3, 2018

Introduction

This adds a note on needing the Pagination plugin to use the fetchPage() function.

This pull request is a followup to #1801 asking me to open a new PR into the master branch.

Motivation

I needed to paginate the results of a query for a project I was doing. So I did a Ctrl-F through the main Bookshelf docs page and the first result was a link on the sidebar to the main documentation section for the fetchPage function. I thought "cool, this is exactly what I need" and tried it out in my code. But it didn't work. I just got the fetchPage is not a function error. So I did some googling around and found issue #1358. That issue yielded the solution that a plugin was needed. I tried that out and it worked.

Admittedly the docs page does mention in several places that the plugin is needed. But, I think adding this note onto the function documentation would be useful.

Proposed solution

Add a note to the method documentation.

@ricardograca
Copy link
Member

ricardograca left a comment

👍

@ricardograca ricardograca merged commit 2cd4755 into bookshelf:master Apr 3, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@ricardograca ricardograca added this to To Do in Version 0.14.0 via automation Apr 3, 2018

@ricardograca ricardograca added the docs label Apr 3, 2018

@ricardograca ricardograca moved this from To Do to Done in Version 0.14.0 Apr 3, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment