Skip to content

docs(query): document that limit=0 uses the server's default limit - #2164

Open
g-despot wants to merge 1 commit into
mainfrom
docs/query-limit-zero
Open

g-despot wants to merge 1 commit into
mainfrom
docs/query-limit-zero

Conversation

@g-despot

Copy link
Copy Markdown
Collaborator

Closes #2150

limit is sent as a proto3 uint32, so limit=0 reaches the server the same as an omitted limit and the server applies its default. This documents that on the limit argument of the query and generate search methods, rather than rejecting 0 as in #2151, which would break callers passing 0 today.

Docstrings only.

`limit` is sent as a proto3 `uint32`, so `0` is indistinguishable from an
omitted limit and the server applies its default. Say so on the `limit`
argument of the query and generate search methods.

@orca-security-eu orca-security-eu Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.73%. Comparing base (95b5d76) to head (0838159).
⚠️ Report is 161 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2164      +/-   ##
==========================================
+ Coverage   86.64%   88.73%   +2.08%     
==========================================
  Files         300      304       +4     
  Lines       23172    24007     +835     
==========================================
+ Hits        20077    21302    +1225     
+ Misses       3095     2705     -390     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fetch_objects(limit=0) returns a default page of objects instead of none

2 participants