docs: Break lines at meaning boundaries - #195
Closed
krlmlr wants to merge 3 commits into
Closed
Conversation
This was referenced Sep 13, 2026
krlmlr
force-pushed
the
claude/badge-harmonization
branch
from
September 13, 2026 16:55
7293653 to
0164654
Compare
krlmlr
force-pushed
the
claude/sembr
branch
from
September 13, 2026 16:55
e94efdc to
95bbea7
Compare
krlmlr
force-pushed
the
claude/sembr
branch
from
September 13, 2026 18:37
95bbea7 to
e2db3a7
Compare
Reformatting only, no wording changes: prose in README.Rmd, the vignettes and the roxygen and inline comments under R/ now breaks at sentence and clause boundaries rather than wrapping to a fixed width. The payoff is sentence-level diffs. A reworded sentence touches one line instead of reflowing the paragraph around it, so review sees the change and not the rewrap. man/*.Rd is regenerated because roxygen2 passes source line breaks through to the .Rd. The rendered help is byte-identical -- checked with tools::Rd2txt() over every topic -- as is the rendered README. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
Continuation lines in roxygen blocks now carry two spaces after the comment marker instead of one, so that a sentence which starts on its own line keeps a full sentence gap in the rendered help. In this package the rendered help is unchanged, and man/*.Rd is not regenerated at all: the package sets `Roxygen: list(markdown = TRUE)`, and in markdown mode roxygen2 strips the leading whitespace of every continuation line before it reaches the .Rd. The indent is therefore source style only here, kept for consistency with the packages where it does carry the gap. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
The two-space continuation indent never reached the `.Rd`. This package sets `Roxygen: list(markdown = TRUE)`, and commonmark strips the leading whitespace of a continuation line before roxygen2 writes the topic. man/ is left to CI, which regenerates it from these sources. A line break which follows the end of a sentence currently renders as one space rather than two. Restoring that gap needs a patched roxygen2, which is a separate decision and a separate pull request, so it is deliberately not part of this change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
krlmlr
force-pushed
the
claude/sembr
branch
from
September 13, 2026 20:36
e2db3a7 to
f17b0f2
Compare
krlmlr
force-pushed
the
claude/badge-harmonization
branch
from
September 13, 2026 20:36
0164654 to
d37ad91
Compare
This was referenced Sep 13, 2026
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.
Superseded by #199, which is the same branch opened with its head in this repository so that it can join the pull request stack. Continue there.
Reformatting only, no wording changes. Prose in
README.Rmd, both vignettes, and the roxygen and inline comments underR/now breaks at sentence and clause boundaries rather than wrapping to a fixed width.The payoff is sentence-level diffs. A reworded sentence touches one line instead of reflowing the paragraph around it, so review sees the change and not the rewrap.
man/is left to CIman/*.Rdis not committed here. roxygen2 passes source line breaks straight through to the.Rd, so reformatting the sources does move the generated files — but they are generated output, and theCommit and push the generated changesstep after Roxygenize regenerates and commits them once this merges.man/therefore ends this branch byte-identical tomain, and the diff stays prose only.The rendered help does not move either way: every topic was compared with
tools::Rd2txt()before and after and is byte-identical. Same for the README — rendered twice, byte-identical both times, and theREADME.md/index.mddiffs contain only line breaks.What was left alone
R/aaa.R— its prose lives in string literals insidepaste(..., sep = "\n")that build the\section{Project root}fragment. That is code, and re-breaking it would change generated output.@examples, and YAML front matter.The sentence gap
A line break which follows the end of a sentence currently renders as one space rather than two, so writing one sentence per line drops the sentence gap from the rendered help. Restoring it needs a patched roxygen2, which is a separate decision: it is #197, stacked on top of this chain, and can be taken or left on its own. Without it this change simply renders as the package renders today.
This is the first of a fleet-wide pass and the one I reviewed by hand before running the rest, so it is the right place to push back on the convention or the mechanics if either looks wrong.
🤖 Generated with Claude Code
https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
Generated by Claude Code