Skip to content

Prep 2.0.1: NEWS, docs, CRAN checklist fixes - #297

Merged
ehwenk merged 3 commits into
masterfrom
docs/296-documentation-checklist
Aug 27, 2026
Merged

ehwenk merged 3 commits into
masterfrom
docs/296-documentation-checklist

Conversation

@ehwenk

@ehwenk ehwenk commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

Works through the Documentation, Code quality, and most of Package
checks / CRAN policy / Version & metadata in the 2.0.1 pre-submission
checklist.

Ref #296

🤖 Generated with Claude Code

ehwenk and others added 3 commits August 27, 2026 14:44
NEWS.md's "APCalign 2.0.0" section had kept accumulating bullets after
the CRAN 2.0.0 submission instead of starting a new heading. Split it:
the six post-submission bullets move to a new "APCalign 2.0.1" section,
joined by two that were missing (#295 fuzzy_match qualifier fix, #293
internal gsub-helper dedupe). The original six 2.0.0 bullets are
unchanged.

Also fixes a devtools::document() warning: match_taxa.R's @details
linked to [apply_match()], an internal @nord helper with no doc topic
to resolve to.

Ref #296

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
- .Rbuildignore: exclude AGENTS.md and CITATION.cff from the built
  package. Both are repo-root files R CMD check doesn't expect
  (CITATION.cff is GitHub's citation format, unrelated to R's own
  inst/CITATION mechanism) — was producing 2 NOTEs.
- DESCRIPTION: Language en -> en-GB. The package consistently uses
  British/Australian spelling (standardise, organisations, labelling,
  favour, behaviour, ...); the ambiguous "en" was defaulting to en-US
  and flagging all of them as misspellings.
- inst/WORDLIST: whitelist the remaining devtools::spell_check() hits
  — proper nouns (AusTraits, APNI, ORCID, GBIF, ...), state/territory
  abbreviations (NSW, Qld, ChI, ...), taxonomic jargon (infraspecific,
  subsp, aff, ...), and species epithets used in examples/tests. None
  were real typos.

devtools::check() now 0 errors, 0 warnings, 0 notes locally, and
devtools::spell_check() passes clean.

Ref #296

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Code quality / CRAN policy pass on the 2.0.1 checklist (items that
don't require live API access to verify):

- default_version() and get_versions() call the GitHub releases API
  directly in their @examples, unwrapped -- every R CMD check with
  --run-donttest (devtools::check()'s default) was hitting that API
  live. Wrapped both in \donttest{}, matching every other
  network-dependent example in the package.
- Replaced remaining T/F shorthand with TRUE/FALSE in user-facing
  example code (README.Rmd, vignettes/APCalign.Rmd) and tests
  (test-state_diversity.R). R/ itself was already clean.
- Added skip_if_offline() to test-connection.R's "functions return
  visibly when online" test, alongside its existing skip_on_ci()/
  skip_on_cran(), so it degrades gracefully under a genuine local
  outage too, not just in CI/CRAN.
- Confirmed clean: devtools::document() (NAMESPACE/man up to date),
  no print()/cat() outside message(), no <<-, no unrestored
  options()/par()/setwd(), no tests writing outside tempfile()/
  tools::R_user_dir().
- DESCRIPTION version bumped 2.0.0 -> 2.0.1.
- cran-comments.md rewritten for the 2.0.1 patch release.

Ref #296

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ehwenk

ehwenk commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator Author

Working detail, commit by commit:

0be5483 — NEWS.md / roxygen fix
NEWS.md's # APCalign 2.0.0 heading kept accumulating bullets after the actual CRAN 2.0.0 submission (per CRAN-SUBMISSION, 2026-03-26) instead of starting a new version heading. Split the six post-submission bullets into a new # APCalign 2.0.1 section, added two that were missing (#295, #293). Also fixed a devtools::document() warning: a dangling roxygen link in match_taxa.R pointed at apply_match(), an internal @noRd helper with no doc topic.

051f530 — check NOTEs / spell_check
.Rbuildignore was missing AGENTS.md/CITATION.cff, producing 2 NOTEs. Language: en in DESCRIPTION was ambiguous and defaulted to en-US, flagging every British/Australian spelling (standardise, organisations, ...) as a typo — fixed to en-GB. Reviewed all 53 remaining spell_check() hits by hand (proper nouns, abbreviations, taxonomic jargon, species epithets) — no real typos — and whitelisted them in inst/WORDLIST.

b4ca39b — donttest / T-F / version bump
Found default_version() and get_versions() call https://api.github.com/repos/traitecoevo/APCalign/releases directly in unwrapped @examples — every devtools::check() (which runs --run-donttest by default) was hitting that endpoint live, unlike every other network-dependent example in the package. Wrapped both in \donttest{}; verified via tools::Rd2ex() that they now compile to ## No test: blocks. Replaced remaining T/F shorthand with TRUE/FALSE in README.Rmd, the vignette, and a test file (R/ itself was already clean). Added skip_if_offline() to test-connection.R's one genuinely-online test. DESCRIPTION bumped to 2.0.1; cran-comments.md rewritten for the patch release.

Known open item: test-connection.R's "functions return visibly when online" test currently fails locally — traced to this dev sandbox's GitHub API rate limit being exhausted from repeated check runs, not a code defect. It's skip_on_cran()-guarded so it won't run during an actual CRAN submission.

@ehwenk ehwenk mentioned this pull request Aug 27, 2026
20 of 24 tasks
@ehwenk
ehwenk merged commit f7a04a2 into master Aug 27, 2026
4 checks passed
@ehwenk
ehwenk deleted the docs/296-documentation-checklist branch August 27, 2026 06:54
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