Skip to content

docs: State the goals and non-goals - #254

Open
krlmlr wants to merge 1 commit into
claude/readme-determinismfrom
claude/readme-goals
Open

krlmlr wants to merge 1 commit into
claude/readme-determinismfrom
claude/readme-goals

Conversation

@krlmlr

@krlmlr krlmlr commented Sep 13, 2026

Copy link
Copy Markdown
Member

Replaces #249, which had its head on a fork and so could not join the pull request stack. Same branch, same commits.

The counterpart to r-lib/here#196 — the two READMEs now point at each other, using wording each package already had.

Evidence:

  • "here sits on top of rprojroot for interactive use" — the README's existing description of itself as a "low-level helper package for the here package", paired with here's own "intended for interactive use only" roxygen.
  • "does not guess which criterion applies"find_root(criterion, path = ".") has no default criterion and errors when nothing matches (R/root.R); the vignette's TL;DR makes you choose.
  • "does not determine the path of the currently running script"thisfile() is soft-deprecated, and the Life cycle section in R/thisfile.R points at the whereami package.
  • "no dependencies beyond base R"DESCRIPTION has no Imports, only Depends: R.

Placed after the library(rprojroot) chunk and before ## Example, so the chunk stays with the intro. The determinism hook added in #248 was not touched, and two renders produced identical bytes despite the random temporary directory.

Only README.Rmd, README.md and index.md change — no R/, no man/.

Stacked on #248, which this PR targets.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m


Generated by Claude Code

@krlmlr
krlmlr added this pull request to stack #256 September 13, 2026 21:48
@krlmlr
krlmlr force-pushed the claude/readme-goals branch from cfc90c7 to e1e84b1 Compare September 13, 2026 21:48
Scope drawn from the repository: the README already describes rprojroot as a
low-level helper package for here, whose own documentation says it is intended
for interactive use only. The criteria list is `NAMESPACE` and `criteria`, the
user-defined criteria and the `|` operator are `root_criterion()`, the required
criterion argument and the error on no match are `find_root()`, the
`whereami` hand-off is the soft-deprecation notice on `thisfile()`, and the
dependency claim is `DESCRIPTION`, which has no `Imports`.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
@krlmlr
krlmlr force-pushed the claude/readme-goals branch from a5388d3 to de1a908 Compare September 14, 2026 05:57
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