Skip to content

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

Merged
ricardograca merged 1 commit into
bookshelf:masterfrom
kevindong:master
Apr 3, 2018
Merged

Add note on needing the Pagination plugin to use fetchPage()#1803
ricardograca merged 1 commit into
bookshelf:masterfrom
kevindong:master

Conversation

@kevindong

Copy link
Copy Markdown
Contributor

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 ricardograca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants