Skip to content

docs: blurb memoise package (closes #353) - #530

Merged
d-morrison merged 5 commits into
mainfrom
feat/issue-353-blurb-memoise
Sep 8, 2026
Merged

docs: blurb memoise package (closes #353)#530
d-morrison merged 5 commits into
mainfrom
feat/issue-353-blurb-memoise

Conversation

@d-morrison

@d-morrison d-morrison commented Sep 7, 2026

Copy link
Copy Markdown
Member

Closes #353

Expands the {memoise} documentation in coding-practices/r-lib-packages.qmd with details on storage backends (cachem::cache_mem(), cachem::cache_disk()), cache invalidation (forget(), is.memoised()), and common use cases (iterative simulations, repeated queries). Also cross-references {memoise} under Additional Resources in coding-practices/benchmarking.qmd.

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1-2-g6ad689f
Preview removed because the pull request was closed.
2026-09-08 17:01 UTC

@d-morrison
d-morrison marked this pull request as ready for review September 7, 2026 17:47
@claude

This comment has been minimized.

Comment thread coding-practices/r-lib-packages.qmd Outdated
Comment thread coding-practices/r-lib-packages.qmd Outdated
@claude

This comment has been minimized.

@claude

This comment has been minimized.

Comment thread coding-practices/r-lib-packages.qmd Outdated
@claude

claude Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Claude finished @d-morrison's task in 1m 34s —— View job


Code Review: PR #530 — docs: blurb memoise package

  • Gather context and identify new commits since last review
  • Read changed files and diff
  • Check for AI hallucinations and technical accuracy
  • Verify content conventions
  • Post findings or confirming verdict

This review covers commit 78aec61 ("prohibit memoising stochastic/RNG functions and format semantic line breaks"), which is the only commit not covered by the prior review from 2026-09-08. That prior verdict — "ready, one optional prose nit" — covered through 094a0c1.

What changed in 78aec61:

  1. The existing {memoise} blurb was reformatted throughout for semantic line breaks.
  2. The stochastic-prohibition paragraph was rewritten — the previous "is passed and sets the generator state deterministically" clause (which I flagged as awkward mixed voice) was replaced with the cleaner "silently collapsing random variability by returning stale cached draws."

Prior inline nits — all resolved:

  • forget() / is.memoised() not namespace-qualified → now memoise::forget(), memoise::is.memoised(), memoise::has_cache()
  • Cache-backend line too long → split across two lines ✅
  • "is passed and sets" mixed-voice clause → removed and rewritten cleanly ✅

Technical accuracy check (unchanged API claims):

  • memoise::memoise(), memoise::forget(), memoise::is.memoised(), memoise::has_cache() — all real exports of memoise 2.0.1
  • cachem::cache_mem(), cachem::cache_disk() — real cachem exports, correctly described ✅
  • cache argument to memoise::memoise() — correct ✅
  • "silently collapsing random variability by returning stale cached draws" — accurate description of the memoisation hazard for stochastic functions ✅

Content conventions:

  • Semantic line breaks: consistently applied throughout the new section ✅
  • Non-standard characters: none introduced ✅
  • Cross-reference @sec-memoise in benchmarking.qmd:545{#sec-memoise} in r-lib-packages.qmd:209 ✅ (unchanged from prior review)

Verdict: The prior "ready" verdict stands. Commit 78aec61 addresses all previously flagged nits, is technically accurate, and follows all repo conventions. No new findings.

@d-morrison

Copy link
Copy Markdown
Member Author

🤖 Antigravity Agent Report

Summary of Changes

The diff modifies two Quarto documentation files within the coding-practices directory:

  1. coding-practices/benchmarking.qmd: Adds an entry for {memoise} under the "Additional Resources" list, including a brief description of function-call caching and a cross-reference link (@sec-memoise) pointing to the package's dedicated section.
  2. coding-practices/r-lib-packages.qmd: Expands the blurb under ### [{memoise}](https://memoise.r-lib.org/) {#sec-memoise} to describe key functionality, supported cachem storage backends (cachem::cache_mem() and cachem::cache_disk()), exported cache inspection and manipulation utilities (memoise::forget(), memoise::is.memoised(), and memoise::has_cache()), appropriate use cases (pure mathematical evaluations, stable API queries, idempotent pipelines), and an explicit rule prohibiting memoisation of stochastic simulation routines and pseudorandom number generators. Formatted using semantic line breaks.

Findings

No actionable findings identified.
[FINDINGS_COUNT: 0]

Verdict: Ready for merge

Reviewed-Commit: 78aec61

Posted by Antigravity (AI agent) --- not written by a human.

@d-morrison
d-morrison merged commit a628565 into main Sep 8, 2026
8 checks passed
@d-morrison
d-morrison deleted the feat/issue-353-blurb-memoise branch September 8, 2026 16: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.

blurb https://memoise.r-lib.org/

1 participant