docs: fix stale v2.0 documentation and remove LLM artefacts#269
Merged
Conversation
Audit of the documentation surface touched by the 2.0.0 release. Stale/incorrect claims corrected: - Preset docs described the retired bespoke `large` preset (biased Wagner, annealing, reduced cycles); `large` is now an alias of `thorough` with maxReplicates=500. Fixed in MaximizeParsimony roxygen, the SearchControl comment, and the search-algorithm / tree-search vignettes. - `default` preset documented as 12 ratchet cycles; it is 6. - Vignette preset claims about adaptiveStart, ratchetTaper, annealCycles and consensusStableReps contradicted the actual SearchControl defaults / preset values. - MaximizeParsimony profile-parsimony docstring claimed binary-only (max 2 states); multi-state is supported (Carter 1990 / Maddison & Slatkin 1991 / Monte Carlo). ConcordantInformation carried the same stale two-state restriction. - PrepareDataProfile: `bootstrap` attribute documented a `split.sizes` entry it never writes; "with a warning" overstated (only the inapplicable-token simplification emits a message). - WideSample `@return` said "uniform sample"; it returns a Max-Min diverse subset. - fractional-weight default documented as 1000L; it is 1260L (NEWS.md). - Implied-weight fit formula rendered as `k / e + k`; corrected to `k / (e + k)` (propagates to inheriting man pages). LLM artefacts removed: - The "reflects island structure, not a cap" framing in the Completeness section (the "256 is not hard-coded" aside was already removed on the branch tip by #251). - NEWS.md: the "common complaint" defensive aside, the empty "Other improvements" section, and a duplicate PaintCharacters bullet. man/*.Rd regenerated with roxygen2. Not addressed here (left for the maintainer): the "To integrate into 2.0.0 notes" scaffold in NEWS.md now also holds #251's breaking-change bullets, and the "renamed to Morphy()" line is stale since #251 removed Morphy() — final integration of that section is #251's to make. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Audit of the documentation surface touched by the 2.0.0 release, checking each claim against the current implementation. Findings were gathered by clustered read-only passes; every fix below is backed by the code it contradicts.
Stale / incorrect claims
largepreset docs described a preset that no longer exists.largeis now an alias ofthorough(presets$large <- presets$thorough) withmaxReplicatesraised to 500, but the roxygen, aSearchControl()comment, andsearch-algorithm.Rmd/tree-search.Rmdstill described the retired bespoke preset (biased Wagner, simulated annealing, reduced cycles).defaultpreset documented as "12 ratchet"; it is 6 (ratchetCycles = 6L).SearchControl()defaults:adaptiveStart"disabled in large" (it isTRUE),ratchetTaper/annealCycles"enabled in thorough/large" (both off),consensusStableReps"default 3" (default 0), and the auto-selection tip/pattern thresholds.MaximizeParsimony()— multi-state is supported (Carter 1990 for 2 states, Maddison & Slatkin 1991 for 3–5, Monte Carlo beyond).ConcordantInformation()carried the same stale two-state restriction.PrepareDataProfile(): documented asplit.sizesbootstrapentry it never writes, and claimed simplification happens "with a warning" when only the inapplicable-token case emits a message.WideSample()@returnsaid "uniform sample"; it returns a Max-Min diverse subset (the function's whole point).1000L; it is1260L.k / e + k; corrected tok / (e + k)(propagates to inheriting man pages).LLM artefacts removed
NEWS.md: the "This addresses a common complaint…" defensive aside, the empty## Other improvementssection, and a duplicatedPaintCharacters()bullet.Deliberately left for the maintainer
# To integrate into 2.0.0 notesscaffold inNEWS.mdnow also holds Replace Morphy with native kernel for inapplicable data #251's breaking-change bullets (MorphyLib removal, function renames), so how it folds into the released 2.0.0 section is that PR's call, not this one's. I applied only the unambiguous fixes within it.renamed to \Morphy()`** line in the 2.0.0 breaking-changes list is now stale, since #251 removedMorphy()` — flagging rather than rewriting, as the correct wording depends on Replace Morphy with native kernel for inapplicable data #251's intended migration story.man/*.Rdregenerated with roxygen2 8.0.0.🤖 Generated with Claude Code