Skip to content

Clarify generation presets and callback contracts - #10

Open
morluto wants to merge 1 commit into
antirez:mainfrom
morluto:agent/clarify-doc-contracts
Open

Clarify generation presets and callback contracts#10
morluto wants to merge 1 commit into
antirez:mainfrom
morluto:agent/clarify-doc-contracts

Conversation

@morluto

@morluto morluto commented Aug 11, 2026

Copy link
Copy Markdown

Summary

Clarifies several user-facing contracts that currently disagree with, or are absent from, the implementation:

  • renames the preset table's Default column to Balanced fast, distinguishing it from the actual reuse=1, 50-layer, native-canvas defaults
  • marks the actual reuse, layer, and core-reuse defaults in --help
  • documents --ref-image-size match|max and how each mode scales reference images
  • documents callback cancellation and argument lifetime in the public header
  • removes the M5-only label from --show, whose availability depends on terminal protocol detection

The generation behavior itself is unchanged.

Validation

  • strict C syntax check for main.c — passed
  • README fenced-code balance check — 34 fence lines, balanced
  • git diff --check — passed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant