Skip to content

docs(base): update location full_address guidance#754

Open
zgz2048 wants to merge 1 commit intolarksuite:mainfrom
zgz2048:codex/base-location-full-address-skill
Open

docs(base): update location full_address guidance#754
zgz2048 wants to merge 1 commit intolarksuite:mainfrom
zgz2048:codex/base-location-full-address-skill

Conversation

@zgz2048
Copy link
Copy Markdown
Collaborator

@zgz2048 zgz2048 commented May 6, 2026

Summary

Update Base skill guidance for location field full_address behavior, covering read/write, filtering, and type conversion semantics.

Changes

  • Document that location writes accept only {lng,lat} and full_address is returned after platform resolution.
  • Clarify that location filters match full_address text and should prefer contains/intersects over short exact matches.
  • Clarify that location -> text conversion keeps full_address, and sync the Base domain template.

Test Plan

  • node scripts/skill-format-check/index.js skills
  • make unit-test
  • Manual local verification: lark-cli base --help

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Clarified geographic location field handling: writes use {lng, lat} format only; reads include full address text.
    • Updated location filtering guidance to use text-based matching, preferring contains over exact match.
    • Refined field type conversion rules for location-to-text transformations.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

📝 Walkthrough

Walkthrough

This PR updates documentation across multiple Lark-base skill references to clarify geographic location field behavior: writes use only {lng,lat} coordinate objects; reads and filtering use the full_address text; text-based filtering prefers contains-matching over exact-matching to avoid short-address false positives.

Changes

Location Field Specification & Guidance

Layer / File(s) Summary
Core Field Definition
skills/lark-base/SKILL.md, skills/lark-base/references/lark-base-cell-value.md, skills/lark-base/references/lark-base-shortcut-field-properties.md, skill-template/domains/base.md
Location field stores coordinates; reads return full_address; writes accept only {lng,lat} and do not require full_address. Platform resolves coordinates to address text upon write.
Write Operations
skills/lark-base/SKILL.md, skills/lark-base/references/lark-base-cell-value.md
Writing location via +record-upsert / +record-batch-* passes {lng,lat} objects only; omit full_address to allow platform resolution.
Read & Query Operations
skills/lark-base/references/lark-base-data-query.md, skills/lark-base/references/lark-base-view-set-filter.md
Location filtering operates as text-based matching on full_address, not coordinate-based. Split text/location filter sections; recommend intersects (contains) over == (exact) for city/district lookups to avoid false matches on short address fragments.
Type Conversion Rules
skills/lark-base/references/lark-base-field-update.md
When converting location to text field, preserve only full_address.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • larksuite/cli#748: Modifies field-update conversion rules for location → text, preserving only full_address.
  • larksuite/cli#636: Updates lark-base cell value docs and location field record write guidance.

Suggested labels

domain/base, size/M

Suggested reviewers

  • kongenpei
  • zhaoleibd

Poem

🐰 A location's heart beats in coordinates true,
Yet full_address speaks the place we pursue.
Write {lng, lat}, let the platform decode,
Read the address text on the information road.
Filter by city, use intersects with care—
Contains beats equals, for matching what's there!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed Title 'docs(base): update location full_address guidance' clearly and concisely summarizes the main change: documentation updates for location field full_address behavior in Base skill.
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.
Description check ✅ Passed PR description matches the template structure with all required sections (Summary, Changes, Test Plan, Related Issues) completed and properly documented.

✏️ 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 and usage tips.

@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 May 6, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.08%. Comparing base (d317493) to head (33a41be).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #754   +/-   ##
=======================================
  Coverage   65.08%   65.08%           
=======================================
  Files         503      503           
  Lines       46581    46581           
=======================================
  Hits        30318    30318           
  Misses      13623    13623           
  Partials     2640     2640           

☔ View full report in Codecov by Sentry.
📢 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.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add zgz2048/cli#codex/base-location-full-address-skill -y -g

@zgz2048 zgz2048 added this to the 2026.5.2-backend milestone May 6, 2026
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.

1 participant