docs(sheets): chart / filter / workbook reference corrections - #1351
Merged
zhengzhijiej-tech merged 3 commits intoJun 9, 2026
Merged
Conversation
The chart reference's placement example used non-existent flags --dimension/--start/--end for +dim-insert. The real signature is --position (required) + --count (required); copying the example fails Validate with "--position is required". Replace it with +dim-insert --position V --count 6 (insert 6 columns before V, i.e. after U), aligning with the sheet-structure reference.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
github-actions
Bot
added
the
size/M
Sync three reference-doc corrections from the spec source:
1. chart: label position.row as 0-based (first row = row:0), distinct
from the 1-based row numbers used by A1 ranges and +dim-insert
--position, removing the row-base ambiguity.
2. chart: convert the three runnable examples whose JSON contains a
quoted sheet prefix ('Sheet1'!A1) from inline single-quoted
--properties '{...}' to a stdin heredoc (--properties - <<'JSON').
Inside an inline single-quoted string bash strips the inner quotes
around the sheet name (and splits names with spaces into words),
corrupting the JSON; a quoted heredoc delimiter performs no shell
substitution and preserves it. Adds a short note on the pitfall.
3. filter / filter-view: add the full conditions[].type x compare_type
enum table (text / number / multiValue / color and their respective
compare_type values and values shape), and call out the
equals/notEquals (with s) vs equal/notEqual (no s) gotcha. The docs
previously only showed two values via examples.
The base flag description for +sheet-create's --index omitted the
coordinate base, while its siblings +sheet-move ("Target position
(0-based)") and +sheet-copy already state 0-based. Align the description
so the index base is unambiguous. Synced from the spec source
(flag-defs.json + workbook reference).
github-actions
Bot
added
domain/ccm
zhengzhijiej-tech
changed the title
xiongyuanwen-byted
pushed a commit
that referenced
this pull request
Jun 22, 2026
docs(sheets): chart / filter / workbook reference corrections
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
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.
Consolidated reference-doc corrections for the sheets skill (synced from the spec source; the larksuite-cli
skills/lark-sheets/tree is generated, not hand-edited).1. chart: invalid
+dim-insertexample (P0)The placement example used non-existent flags
--dimension/--start/--end. The real signature is--position+--count; copying it failed Validate with--position is required. Fixed to+dim-insert --position V --count 6(insert 6 columns before V, i.e. after U).2. chart:
position.rowcoordinate baseposition.rowis 0-based (first row =row:0) but was never labeled, while+dim-insert --positionand A1 ranges use 1-based rows. Added an explicit 0-based note in the placement checklist.3. chart: inline
--propertiesquoting pitfallThe three runnable examples contained a quoted sheet prefix (
'Sheet1'!A1) inside an inline single-quoted--properties '{...}'; bash strips the inner quotes (and splits names with spaces into words), corrupting the JSON. Converted them to a stdin heredoc (--properties - <<'JSON' … JSON, whose quoted delimiter performs no shell substitution); kept the@filealternative and added a one-line pitfall note.4. filter / filter-view: condition enums
conditions[].type/compare_typeare nested too deep to render in the flag table, so the docs only exposed two values via examples. Added the fulltype × compare_type × valuesenum table to both, and called out theequals/notEquals(with s) vsequal/notEqual(no s) gotcha.5. workbook:
+sheet-create --index0-basedThe flag description omitted the coordinate base while siblings
+sheet-move/+sheet-copyalready state 0-based. Aligned the description.Scope
skills/lark-sheets/references/lark-sheets-{chart,filter,filter-view,workbook}.md+shortcuts/sheets/data/flag-defs.json, all synced from the spec; the corresponding source fixes (canonical + base) are tracked upstream.