Skip to content

docs: fix root calendar example#299

Merged
calendar-assistant merged 1 commit intomainfrom
fix/issue-48-root-help-example
Apr 7, 2026
Merged

docs: fix root calendar example#299
calendar-assistant merged 1 commit intomainfrom
fix/issue-48-root-help-example

Conversation

@calendar-assistant
Copy link
Copy Markdown
Collaborator

@calendar-assistant calendar-assistant commented Apr 7, 2026

Summary

Fix the stale root help example for calendar events so the command shown in lark-cli --help matches the current CLI surface.

Changes

  • Replace the removed calendar events list example in cmd/root.go
  • Use calendar events instance_view with the required time range parameters

Test Plan

  • Unit tests pass
  • Manual local verification confirms the lark xxx command works as expected (GOCACHE=/tmp/go-build go run . --help)

Related Issues

Summary by CodeRabbit

  • Documentation
    • Updated CLI documentation example for calendar events to demonstrate querying with time range parameters.

Change-Id: I25e58345019046bf961636b10e8baad522019279
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added the size/L Large or sensitive change across domains or core paths label Apr 7, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 7, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 43b9573c-f689-4356-8d99-ab236a182afb

📥 Commits

Reviewing files that changed from the base of the PR and between c9b660a and 3b4d092.

📒 Files selected for processing (1)
  • cmd/root.go

📝 Walkthrough

Walkthrough

Updated the CLI documentation example in cmd/root.go to reflect the current command surface. The example changed from calendar events list to calendar events instance_view with additional start_time and end_time parameters. No functional code changes were made.

Changes

Cohort / File(s) Summary
CLI Documentation Update
cmd/root.go
Updated the rootLong help text example: replaced the calendar events list command with calendar events instance_view and added required start_time and end_time parameters to match the actual CLI surface.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

size/S

Suggested reviewers

  • liangshuo-1

Poem

🐰 ✨ A hop and a skip through the CLI so neat,
The examples now match what users will meet,
No more confusing paths that lead astray,
Just honest examples to light the way! 📚

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/issue-48-root-help-example

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Apr 7, 2026

Greptile Summary

Replaces the stale calendar events list example in the --help output with calendar events instance_view, adding the required start_time and end_time parameters to accurately reflect the current CLI surface. No functional or logic changes are made — this is a purely cosmetic correction to the help text string in cmd/root.go.

Confidence Score: 5/5

Safe to merge — purely a documentation fix with no logic changes.

Single-line help-text update with no code logic changes; no P0 or P1 findings.

No files require special attention.

Important Files Changed

Filename Overview
cmd/root.go Single-line doc fix: replaces stale calendar events list example with calendar events instance_view plus required time-range parameters in the root help text

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI as lark-cli
    User->>CLI: lark-cli --help
    CLI-->>User: Displays updated example<br/>calendar events instance_view<br/>with start_time & end_time params
Loading

Reviews (1): Last reviewed commit: "docs: fix root calendar example" | Re-trigger Greptile

@calendar-assistant calendar-assistant merged commit a143858 into main Apr 7, 2026
11 of 13 checks passed
@calendar-assistant calendar-assistant deleted the fix/issue-48-root-help-example branch April 7, 2026 13:38
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 7, 2026

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@3b4d092c0b88581995194e25dc5d126aaa654f4c

🧩 Skill update

npx skills add larksuite/cli#fix/issue-48-root-help-example -y -g

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

Labels

size/L Large or sensitive change across domains or core paths

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Help and README examples drift from the current CLI surface

3 participants