Skip to content

docs(slides): correct +xml-get flag requirements - #2171

Merged
R0bynZhu merged 1 commit into
mainfrom
fix/slides-xml-get-output-optional
Aug 4, 2026
Merged

docs(slides): correct +xml-get flag requirements#2171
R0bynZhu merged 1 commit into
mainfrom
fix/slides-xml-get-output-optional

Conversation

@R0bynZhu

@R0bynZhu R0bynZhu commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Neither --output nor --json is required: omitting --output returns the XML in the JSON envelope on stdout, and json is the default --format.

Summary by CodeRabbit

  • Documentation
    • Clarified that --output and --json options are optional when retrieving presentation data.
    • Documented default JSON output and stdout JSON-envelope behavior.

Neither --output nor --json is required: omitting --output returns the XML
in the JSON envelope on stdout, and json is the default --format.
@github-actions github-actions Bot added the size/M Single-domain feat or fix with limited business impact label Aug 4, 2026
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c963fe19-16f3-40d0-b020-883aa26316c9

📥 Commits

Reviewing files that changed from the base of the PR and between 0f29e03 and e82f5d8.

📒 Files selected for processing (1)
  • skills/lark-slides/references/lark-slides-xml-presentations-get.md

📝 Walkthrough

Walkthrough

The documentation for slides +xml-get now marks --output and --json as optional. It documents relative-path XML output and stdout JSON-envelope behavior.

Changes

XML presentations get

Layer / File(s) Summary
Document optional output and JSON behavior
skills/lark-slides/references/lark-slides-xml-presentations-get.md
The shortcut documentation explains that --output saves XML to a relative path when provided, while omitted output returns XML in the stdout JSON envelope. It also states that JSON is the default format.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: liangshuo-1

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description states the documentation change but omits the required Summary, Changes, Test Plan, and Related Issues sections. Add the required sections and document the changes, verification steps, and related issues or state that none apply.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the documentation correction for the Slides +xml-get flag requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/slides-xml-get-output-optional

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#fix/slides-xml-get-output-optional -y -g

@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.69%. Comparing base (0f29e03) to head (e82f5d8).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2171   +/-   ##
=======================================
  Coverage   75.69%   75.69%           
=======================================
  Files         942      942           
  Lines      100079   100079           
=======================================
  Hits        75750    75750           
  Misses      18537    18537           
  Partials     5792     5792           

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@BD-ZERO
BD-ZERO self-requested a review August 4, 2026 04:36
@R0bynZhu
R0bynZhu merged commit f1dc4fc into main Aug 4, 2026
31 of 44 checks passed
@R0bynZhu
R0bynZhu deleted the fix/slides-xml-get-output-optional branch August 4, 2026 06:01
@liangshuo-1 liangshuo-1 mentioned this pull request Aug 4, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants