Standardise documentation for pagination parameters #554
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.
I've tried to document all parameters related to pagination in one place: the documentation for
TWIT_paginate_max_id
/TWIT_paginate_cursor
. This means that the docs lose less specific details about the endpoint (e.g. specific page sizes and rate limits) but gain more general details about how all the pieces fit together.@llrs I think the best place to focus on is the
TWIT_paginate_max_id
documentation, since that now flows out to the majority of functions in rtweet. Let me know if there's anything you think is confusing so that I can improve the wording as much as possible.