Skip to content

docs(base): clarify field description usage in json#90

Open
zgz2048 wants to merge 2 commits intolarksuite:mainfrom
zgz2048:codex/base-field-description-sync
Open

docs(base): clarify field description usage in json#90
zgz2048 wants to merge 2 commits intolarksuite:mainfrom
zgz2048:codex/base-field-description-sync

Conversation

@zgz2048
Copy link
Copy Markdown
Collaborator

@zgz2048 zgz2048 commented Mar 30, 2026

Summary

  • clarify in base field shortcut help text that description should be passed via --json.description
  • update base field skill/reference docs to keep the existing --json model
  • drop the extra field-specific flag and test/code-path changes from the earlier revision

Why

The existing field shortcuts already pass arbitrary JSON bodies through. This update only needs to make the description usage explicit while keeping the original command shape.

Validation

  • go test ./shortcuts/base -run 'Test(DryRunFieldOps|BaseFieldExecuteUpdate|BaseFieldExecuteCRUD|BuildFieldBody)$'

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 30, 2026

CLA assistant check
All committers have signed the CLA.

@zgz2048 zgz2048 changed the title [codex] support base field description input feat(base): support base field description input Mar 30, 2026
@zgz2048 zgz2048 self-assigned this Mar 30, 2026
@zgz2048 zgz2048 changed the title feat(base): support base field description input docs(base): clarify field description usage in json Mar 30, 2026
@zgz2048 zgz2048 force-pushed the codex/base-field-description-sync branch from 1448194 to 65cbdbd Compare March 30, 2026 09:17
@zgz2048 zgz2048 marked this pull request as ready for review March 30, 2026 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants