Add note on needing the Pagination plugin to use fetchPage() - #1803
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fetchPageis not a function #1358Introduction
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
fetchPagefunction. I thought "cool, this is exactly what I need" and tried it out in my code. But it didn't work. I just got thefetchPage is not a functionerror. 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.