Skip to content

Commit f9cae3f

Browse files
committed
reprexes skill: sync canonical (usage note + helpers out of args list)
1 parent f637473 commit f9cae3f

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

.claude/skills/reprexes/SKILL.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,8 @@ but nothing more.
9898
Copy the code and call `reprex::reprex()` (reads the clipboard by default),
9999
or point it at a file with `reprex(input = "/tmp/reprex.R")` (or a
100100
`tempfile(fileext = ".R")` path on non-Unix machines) — handy from a
101-
non-interactive CLI session where there's no clipboard. Useful arguments:
101+
non-interactive CLI session where there's no clipboard. Use it when the
102+
output is destined for a PR comment or an upstream issue. Useful arguments:
102103
- `venue =` — output format:
103104
- `"gh"` — GitHub-flavored Markdown (default)
104105
- `"so"` / `"ds"` — Stack Overflow / Discourse
@@ -112,16 +113,15 @@ but nothing more.
112113
- `std_out_err = TRUE` — capture stdout/stderr too (e.g. `system()` /
113114
subprocess or C-level output that doesn't come back as normal R results).
114115
- `wd =` — set the working directory when the code needs one.
115-
- Use this when the reprex is destined for a PR comment or an upstream
116-
issue. Companion helpers handle "wild-caught" reprexes (all exported in
117-
reprex 2.x): `reprex_clean()` (strip the `#>` output markers from a
118-
rendered/pasted reprex, leaving runnable code), `reprex_rescue()`
119-
(recover code from R-console output with `>`/`+` prompts), and
120-
`reprex_invert()` (the inverse of `reprex()` — recover the input code
121-
from a rendered reprex).
122116
- Validation bonus: because `reprex()` runs in a fresh session, if it errors
123117
on a missing object or package, your example wasn't actually
124118
self-contained — fix that before sharing.
119+
120+
Companion helpers handle "wild-caught" reprexes (all exported in reprex
121+
2.x): `reprex_clean()` (strip the `#>` output markers from a rendered/pasted
122+
reprex, leaving runnable code), `reprex_rescue()` (recover code from
123+
R-console output with `>`/`+` prompts), and `reprex_invert()` (the inverse
124+
of `reprex()` — recover the input code from a rendered reprex).
125125
- When the bug might be **version-dependent**, capture `sessionInfo()` (or set
126126
`session_info = TRUE` above) in the reprex so versions are part of the
127127
record. If you suspect *stale* packages are the cause,

0 commit comments

Comments
 (0)