docs(api.py): Add note about 10,000 results API limitation #321
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
github-project-automation
bot
moved this to In progress
in 🐍 Python SDK - Keep on par with the API
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This pull request adds a clarifying note at the top of the
api.pyfile to highlight the Open Food Facts API's 10,000 results limitation. This helps developers be aware of potential query issues when dealing with large datasets.Why this is useful
While working on the Python SDK as part of my exploration for Google Summer of Code 2025, I noticed that the API has an undocumented limit of 10,000 results, which could confuse new developers or lead to unexpected behavior in large queries. This small documentation update adds clarity and helps prevent confusion.
Context
This is part of my first-time contributions to the Open Food Facts project under the GSoC 2025 exploration. I plan to work on improving SDK usability and developer experience.
Let me know if anything else needs to be added or adjusted :)