Add documentation specifying the per_page default of 30. #656
Conversation
This file contains 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
Let users know what the default value is within the documentation.
…with-per-page-defaults Update README.md
tejasbubane
reviewed
Jan 24, 2025
| @@ -33,7 +33,7 @@ class Post | |||
| self.per_page = 10 | |||
| end | |||
|
|
|||
| # set per_page globally | |||
| # set per_page globally (If this setting is left unspecified the default value is 30) | |||
There was a problem hiding this comment.
I would put it on line 28 implying it also applies for class Post if not specified.
|
Hi, thank you for the suggestion, but the default being 30 is already documented in our API documentation on the wiki and I don't feel like it needs to be repeated in too many places. |
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.
Adding default per_page to documentation to make it more explicit for developers.