Skip to content

Clarify pagination description in API Reference. #9548

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 2 commits into
base: v2
Choose a base branch
from
Draft

Clarify pagination description in API Reference. #9548

wants to merge 2 commits into from

Conversation

aemous
Copy link
Contributor

@aemous aemous commented Jun 13, 2025 •
edited
Loading

Issues:

Description of changes:

  • Clarified pagination description on paginated operations to prevent recurring tickets on customer confusion with the --no-paginate arg.

Description of tests:

  • Regenerated docs using Makefile. TODO paste results

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

kdaily
kdaily approved these changes Jun 13, 2025
View reviewed changes
Copy link
Member

@kdaily kdaily left a comment

Choose a reason for hiding this comment

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

LGTM other than a non-blocking comment for wording on the result of disabling auto-pagination. Hopefully this is more clear for users!

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

@kdaily kdaily kdaily approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aemous @kdaily