Skip to content

Fix CRAN-page README rendering and dispatcher arg validation - #57

Merged
TroyHernandez merged 3 commits into
mainfrom
fix/cran-page-polish
Aug 11, 2026
Merged

Fix CRAN-page README rendering and dispatcher arg validation#57
TroyHernandez merged 3 commits into
mainfrom
fix/cran-page-polish

Conversation

@TroyHernandez

Copy link
Copy Markdown
Contributor

Announcement-day polish: fixes for what a new user hits first (the CRAN-rendered README and the bare dispatcher calls).

README (visible on the CRAN page right now)

  • The ```r fence opened before the FLUX examples never closed, so the whole LTX section rendered inside a code block and the dispatcher one-liner rendered outside one. Closed it; the dispatcher example is now its own block.
  • cat2.png and gambling_cat.png are .Rbuildignored, so the relative image embeds 404 on CRAN. Now absolute GitHub URLs (no tarball bloat).
  • The minimal LTX example didn't run as written: ltx23_load_pipeline() has no checkpoint_path default, and txt2vid_ltx2() needs text_encoder + tokenizer (or embeds). Replaced with the working call shape chained off download_ltx2()'s return value, mirroring R/serve.R. Also fp8 → nf4 in the download comment (nf4 has been the default since 0.2.2).

Dispatchers

txt2img("a cat") errored with EXPR must be a length 1 vector, and img2img() errored on the length-2 choices vector in an if() condition. Both now match.arg() their model_name and default to sd21. tinytest covers the rejection message.

The rformat + document commit is churn only (7 files rejoined by rformat, man pages rewrapped by tinyrox); the functional diff is the first commit.

GitHub's README updates immediately; the CRAN copy follows at the next release.

…raffic

- Close the unclosed fence after the Z-Image example: the whole LTX
  section rendered inside a code block on the CRAN page, and the
  dispatcher one-liner rendered outside one (now its own block).
- Point cat2.png / gambling_cat.png embeds at raw.githubusercontent
  URLs; both files are .Rbuildignore'd, so the relative refs 404 on
  the CRAN-rendered README.
- Replace the LTX example with the working call shape (mirrors
  R/serve.R): ltx23_load_pipeline() has no checkpoint_path default and
  txt2vid_ltx2() needs text_encoder + tokenizer. Also fp8 -> nf4 in
  the download comment (nf4 is the default since 0.2.2).
- match.arg() in txt2img() and img2img(): bare txt2img("a cat")
  errored with "EXPR must be a length 1 vector", img2img errored on
  the length-2 vector condition. Both now default to sd21, with a
  tinytest covering the rejection message.
@TroyHernandez
TroyHernandez merged commit 4e67bef into main Aug 11, 2026
2 checks passed
@TroyHernandez
TroyHernandez deleted the fix/cran-page-polish branch August 11, 2026 11:18
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