Skip to content
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.

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

[Documentation] - Replace limit=123/maxResults=123 placeholders with actual valid range or max value #4088

Open
tim-finnigan opened this issue Apr 17, 2024 · 0 comments
Labels
documentation This is a problem with documentation. feature-request This issue requests a feature. p3 This is a minor priority issue

Comments

@tim-finnigan
Copy link
Contributor

tim-finnigan commented Apr 17, 2024

Describe the issue

In the Boto3 documentation, limit=123 (or Limit=123) is used as a placeholder to show how a limit value is passed. For example, see the describe_log_users command. But the maximum value for limit in that example is actually 50. This can be confusing, because different commands/APIs have varying valid ranges.

So the request is: can we document the "Valid Range" for limit in the Boto3 documentation, or document the actual maximum value allowed per command?

There was already some team discussion regarding this issue: if a range were documented, then that would also be misleading because the request expects an integer, not a range. And if the maximum value is shown, then that might lead to some customers paying more for requests than they intended. So there is still some debate as far as the best path forward here.

This issue has been reported a few times, for example:

We decided to close those issues in favor of using this as a consolidated tracking issue. Please feel free to 👍 this issue and comment with any feedback/questions.

@tim-finnigan tim-finnigan added documentation This is a problem with documentation. feature-request This issue requests a feature. p3 This is a minor priority issue labels Apr 17, 2024
@tim-finnigan tim-finnigan changed the title [Documentation] - Replace limit=123 placeholder with actual valid range or max value [Documentation] - Replace limit=123/maxItems=123` placeholders with actual valid range or max value Jun 28, 2024
@tim-finnigan tim-finnigan changed the title [Documentation] - Replace limit=123/maxItems=123` placeholders with actual valid range or max value [Documentation] - Replace limit=123/maxItems=123 placeholders with actual valid range or max value Jun 28, 2024
@tim-finnigan tim-finnigan changed the title [Documentation] - Replace limit=123/maxItems=123 placeholders with actual valid range or max value [Documentation] - Replace limit=123/maxResults=123 placeholders with actual valid range or max value Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. feature-request This issue requests a feature. p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

1 participant