Skip to content

docs: clarify base percentage number values#1575

Open
zgz2048 wants to merge 1 commit into
larksuite:mainfrom
zgz2048:codex/base-percentage-docs
Open

docs: clarify base percentage number values#1575
zgz2048 wants to merge 1 commit into
larksuite:mainfrom
zgz2048:codex/base-percentage-docs

Conversation

@zgz2048

@zgz2048 zgz2048 commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Summary

Clarifies that Base percentage number formatting only affects frontend display. Agents should write the underlying numeric value for CellValue and field default_value instead of the displayed percentage text.

Changes

  • Document style.percentage=true semantics in Base CellValue guidance.
  • Document the same rule for number field JSON defaults and record values.

Test Plan

  • Unit tests pass
  • Manual local verification confirms the lark-cli <domain> <command> flow works as expected
  • git diff --check

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Clarified how numeric percentage styling behaves in Lark Base: percentage display is front-end only, while saved values remain the underlying number.
    • Updated guidance so both default values and cell values are written in numeric form, including for progress-style fields.

@coderabbitai

coderabbitai Bot commented Jun 25, 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

Run ID: 935e70eb-c40f-4765-9983-46aed183130c

📥 Commits

Reviewing files that changed from the base of the PR and between 1c92ed8 and 805c125.

📒 Files selected for processing (2)
  • skills/lark-base/references/lark-base-cell-value.md
  • skills/lark-base/references/lark-base-field-json.md

📝 Walkthrough

Walkthrough

The PR updates Lark Base reference docs to state that number.style.percentage=true only affects front-end display. It clarifies that default_value and stored CellValue values remain the underlying numeric number.

Changes

Lark Base percentage docs

Layer / File(s) Summary
Number percentage semantics
skills/lark-base/references/lark-base-field-json.md, skills/lark-base/references/lark-base-cell-value.md
number field JSON and CellValue docs now say style.percentage=true changes display only, while stored values and default_value remain the underlying numeric value.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I nibbled docs by moonbeam light,
Percent on screen, but stored is right.
Raw numbers hop, both plain and bright,
Progress too keeps truth in sight.
Carrot-cheer for a tidy write!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the docs change about Base percentage number values and matches the main scope of the PR.
Description check ✅ Passed The description follows the required template and covers summary, changes, test plan, and related issues sufficiently.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 added domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact labels Jun 25, 2026
@zgz2048 zgz2048 marked this pull request as ready for review June 25, 2026 07:24
@zgz2048 zgz2048 force-pushed the codex/base-percentage-docs branch from f36da9d to 805c125 Compare June 25, 2026 07:26
@zgz2048 zgz2048 changed the title [codex] docs: clarify base percentage number values docs: clarify base percentage number values Jun 25, 2026
@github-actions

github-actions Bot commented Jun 25, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add zgz2048/cli#codex/base-percentage-docs -y -g

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

Labels

domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants