docs(lark-base): add has_more guidance for record-list pagination#183
docs(lark-base): add has_more guidance for record-list pagination#183
Conversation
Greptile SummaryThis is a documentation-only PR that adds explicit pagination guidance for the
Confidence Score: 5/5Documentation-only changes with no runtime impact; safe to merge. Both changed files are purely documentation. The new content is accurate, internally consistent across the two files, and improves clarity around a previously under-documented pagination behavior. No code paths are affected. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A([Start]) --> B["Call +record-list\n(offset=0, limit≤200)"]
B --> C{Check has_more}
C -- "false" --> D([Done – return results])
C -- "true" --> E{Does user need\nmore data?}
E -- "No\n(e.g. 'show examples',\n'first N rows')" --> D
E -- "Yes\n(e.g. 'export all',\n'full detail')" --> F["Increment offset\nby records read"]
F --> G["Call +record-list\n(next page)"]
G --> H{Check has_more}
H -- "false" --> D
H -- "true" --> E
Reviews (2): Last reviewed commit: "docs(lark-base): refine record-list key ..." | Re-trigger Greptile |
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@a63815bddfd272996fdf349de191cb87758c6a3c🧩 Skill updatenpx skills add larksuite/cli#codex/record-list-has-more-guidance -y -g |
📝 WalkthroughWalkthroughUpdated pagination guidelines in Lark-base documentation to introduce conditional pagination rules based on the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
skills/lark-base/references/lark-base-record-list.md (1)
21-21: Clarify offset progression wording for non-zero starting offset.“按已读取数量递增” is directionally correct, but adding one concrete formula/example would reduce ambiguity (e.g.,
next_offset = current_offset + len(items)), especially when the first call is notoffset=0.✏️ Suggested wording tweak
-5. 继续翻页时,`offset` 按已读取数量递增,直到满足用户需求或 `has_more = false`。 +5. 继续翻页时,`offset` 按“当前 offset + 本页实际返回条数”递增(例如 `next_offset = current_offset + len(items)`),直到满足用户需求或 `has_more = false`。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-record-list.md` at line 21, 说明当前关于翻页偏移的表述对非零起始 offset 不够明确;将第 5 点改为用明确公式和示例说明偏移如何递增,例如写成 “继续翻页时,下一次请求的 offset = current_offset + len(items)(即 next_offset = current_offset + len(items)),直到满足用户需求或 has_more = false”,并在文中保留对 offset、items 和 has_more 的术语一致性以避免歧义。
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@skills/lark-base/references/lark-base-record-list.md`:
- Line 21: 说明当前关于翻页偏移的表述对非零起始 offset 不够明确;将第 5 点改为用明确公式和示例说明偏移如何递增,例如写成
“继续翻页时,下一次请求的 offset = current_offset + len(items)(即 next_offset =
current_offset + len(items)),直到满足用户需求或 has_more = false”,并在文中保留对 offset、items 和
has_more 的术语一致性以避免歧义。
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c1ee69c9-7b48-4442-ae4e-a0f9a19cca1e
📒 Files selected for processing (2)
skills/lark-base/SKILL.mdskills/lark-base/references/lark-base-record-list.md
Summary
Testing
Summary by CodeRabbit
Documentation