Conversation
krlmlr
force-pushed
the
claude/readme-rmd
branch
from
September 13, 2026 16:33
0447628 to
c2000a7
Compare
krlmlr
force-pushed
the
claude/readme-rmd
branch
2 times, most recently
from
September 13, 2026 18:19
85c9569 to
b4f1889
Compare
krlmlr
force-pushed
the
claude/readme-rmd
branch
2 times, most recently
from
September 13, 2026 18:50
66ac5ce to
08d2ab2
Compare
krlmlr
added this pull request to stack #2907
September 13, 2026 21:25
krlmlr
force-pushed
the
claude/readme-rmd
branch
from
September 13, 2026 21:26
08d2ab2 to
8481b77
Compare
The hand-written `README.md` keeps the package out of the shared rendering pipeline, so this adds a `README.Rmd` copied from it verbatim, prefixed with the `cynkratemplate::readme_document` front matter and the canonical generated-file comment. Rendering with `cynkratemplate::render_readme()` writes no `index.md` here, because this `README.md` has no code-of-conduct footer to strip, so only `README.Rmd` is added to `.Rbuildignore`. Outside the contributors table the rendered `README.md` differs from the hand-written one only in pandoc's gfm normalisations: the generated-file comment, a blank line after `<!-- badges: start -->`, ` ```r ` written as ` ``` r `, an untagged fence written as an indented block, `>=` written as `\>=`, and trailing blank lines dropped. Inside the `allcontributors` block pandoc preserves every non-blank line byte for byte and inserts a blank line between the raw-HTML fragments, which grows the file by 1171 lines without changing what it renders to. No word, URL, or code-block content changes anywhere. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
krlmlr
force-pushed
the
claude/readme-rmd
branch
from
September 13, 2026 21:41
a9b6c56 to
b35b805
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Last of six packages to join the shared README rendering pipeline, after r-dbi/DBItest#565, r-dbi/RMariaDB#562, r-dbi/RPostgres#609, r-dbi/RKazam#115 and cynkra/cynkratemplate#127.
README.Rmdis a byte-for-byte copy of the existingREADME.md, prefixed only with thecynkratemplate::readme_documentfront matter and the canonical generated-file comment.README.mdis then the output ofcynkratemplate::render_readme().No
index.mdhere:cynkratemplateonly writes one when the README has a code-of-conduct footer to strip for pkgdown, and this one does not. So.Rbuildignoregains^README\.Rmd$only.The allcontributors block
This README is 3942 lines, of which 3680 are the raw-HTML contributors table. Pandoc has to carry all of it through a markdown → AST → markdown round trip, so that block was the thing to check before anything else.
It survives intact, but it does grow. Pandoc inserts a blank line between the raw-HTML fragments, which takes
README.mdfrom 3942 to 5108 lines. That is the entire reason this diff is 1364 lines. Nothing inside the block is reworded, reindented or rewrapped:diffof the blank-stripped block: empty).https?://URLs in the file is identical, 1767 of them each side — this is the check that matters, since the block carries an avatar URL and two profile URLs per contributor.pandoc -f gfm -t htmlover both files produces identical output apart from the added generated-file comment, so what GitHub renders does not change.The block is generated, so the expansion is not permanent churn in one direction:
allcontributors::add_contributors()defaults tofiles = c("README.Rmd", "README.md"), so the next release-checklist run rewrites the block in both files in its own compact form, and the following render re-expands theREADME.mdcopy. Worth knowing before the next release, since it will show up as a large diff again.If the growth is unwanted, this is one commit on its own branch and can simply be dropped.
Everything else
Outside the block, 14 old lines change and 11 new ones appear, all of them pandoc's gfm normalisations:
<!-- badges: start -->```rfences written as``` r```fence written as a four-space indented block, contents unchangedR >= 4.0written asR \>= 4.0in prose, which renders the sameVerified mechanically rather than by eye: the sorted multiset of whitespace-separated tokens differs only by the words of the generated-file comment and by the three fence tags and the one backslash listed above. No word, no URL and no code-block content changes anywhere in the file.
Build
R CMD buildsucceeds with no warnings, vignettes and compiled sources included.tar tzfon the resulting tarball shows no top-levelREADME.Rmd,README.mdorindex.md— the onlyREADMEentries are vendored ones undersrc/.Where this sits
Stacked on
claude/sembr(#2903), which is the current tip of the open chain — #2904 onclaude/fix-man-driftwas closed becausemainalready carries that fix, so building on it would drag an abandoned change into this diff. It is stacked rather than inserted at the bottom of the chain so that #2902 and #2903 do not need rewriting. Only.Rbuildignore,README.RmdandREADME.mdare touched; nothing underR/.🤖 Generated with Claude Code
https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
Generated by Claude Code