Skip to content

Document internal helpers and centralize shared internal params#97

Merged
jonthegeek merged 13 commits into
mainfrom
copilot/document-internal-functions
May 17, 2026
Merged

Document internal helpers and centralize shared internal params#97
jonthegeek merged 13 commits into
mainfrom
copilot/document-internal-functions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 16, 2026 •
edited
Loading

  • Inspect the review comment and current @returns usage across /home/runner/work/beekeeper/beekeeper/R
  • Standardize @returns tags to begin with tick-enclosed types in parentheses wherever a return type is documented
  • Regenerate documentation and run targeted validation for the updated roxygen docs
  • Run full package verification and reply to the review comment

Copilot AI linked an issue May 16, 2026 that may be closed by this pull request
Document internal functions #96
Closed
Copilot AI and others added 2 commits May 16, 2026 19:00
@jonthegeek
Document internal helper functions
e32def9 
Agent-Logs-Url: https://github.com/api2r/beekeeper/sessions/fbf4f879-da36-4e65-975f-6ef573695aa6

Co-authored-by: jonthegeek <33983824+jonthegeek@users.noreply.github.com>
@jonthegeek
Polish internal documentation test
84473f8 
Agent-Logs-Url: https://github.com/api2r/beekeeper/sessions/fbf4f879-da36-4e65-975f-6ef573695aa6

Co-authored-by: jonthegeek <33983824+jonthegeek@users.noreply.github.com>
Copilot AI changed the title [WIP] Document internal functions as per guidelines Document internal helpers and centralize shared internal params May 16, 2026
Copilot AI requested a review from jonthegeek May 16, 2026 19:05
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 16, 2026 •
edited
Loading

{qcthat} Report: User Acceptance

No issues are awaiting UAT.

This report was generated by this GitHub Actions run.

Last updated: 2026-05-17 12:42:28 UTC

Session Info ─ Session info ───────────────────────────────────────────────────────────────

setting value

version R version 4.6.0 (2026-04-24)

os Ubuntu 24.04.4 LTS

system x86_64, linux-gnu

ui X11

language (EN)

collate en_US.UTF-8

ctype en_US.UTF-8

tz UTC

date 2026-05-17

pandoc 3.1.3 @ /usr/bin/pandoc

quarto NA

─ Packages ───────────────────────────────────────────────────────────────────

package * version date (UTC) lib source

askpass 1.2.1 2024-10-04 [1] RSPM

astgrepr 0.1.1 2025-06-07 [1] RSPM

backports 1.5.1 2026-04-03 [1] RSPM

base * 4.6.0 2026-04-24 [2] local

base64enc 0.1-6 2026-02-02 [1] RSPM

beekeeper 0.4.0.9000 2026-05-17 [1] local

boot 1.3-32 2025-08-29 [2] CRAN (R 4.6.0)

brew 1.0-10 2023-12-16 [1] RSPM

brio 1.1.5 2024-04-24 [1] RSPM

bslib 0.11.0 2026-05-16 [1] RSPM

cachem 1.1.0 2024-05-16 [1] RSPM

callr 3.7.6 2024-03-25 [1] RSPM

checkmate 2.3.4 2026-02-03 [1] RSPM

class 7.3-23 2025-01-01 [2] CRAN (R 4.6.0)

cli 3.6.6 2026-04-09 [1] RSPM

clipr 0.8.0 2022-02-22 [1] RSPM

cluster 2.1.8.2 2026-02-05 [2] CRAN (R 4.6.0)

codetools 0.2-20 2024-03-31 [2] CRAN (R 4.6.0)

commonmark 2.0.0 2025-07-07 [1] RSPM

compiler 4.6.0 2026-04-24 [2] local

covr 3.6.5 2025-11-09 [1] RSPM

crayon 1.5.3 2024-06-20 [1] RSPM

credentials 2.0.3 2025-09-12 [1] RSPM

curl 7.1.0 2026-04-22 [1] RSPM

datasets * 4.6.0 2026-04-24 [2] local

desc 1.4.3 2023-12-10 [1] RSPM

devtools 2.5.2 2026-04-30 [1] RSPM

diffobj 0.3.6 2025-04-21 [1] RSPM

digest 0.6.39 2025-11-19 [1] RSPM

docopt 0.7.2 2025-03-25 [1] RSPM (R 4.6.0)

downlit 0.4.5 2025-11-14 [1] RSPM

dplyr 1.2.1 2026-04-03 [1] RSPM

ellipsis 0.3.3 2026-04-04 [1] RSPM

emoji 16.0.0 2024-10-28 [1] RSPM

evaluate 1.0.5 2025-08-27 [1] RSPM

fansi 1.0.7 2025-11-19 [1] RSPM

fastmap 1.2.0 2024-05-15 [1] RSPM

fontawesome 0.5.3 2024-11-16 [1] RSPM

foreign 0.8-91 2026-01-29 [2] CRAN (R 4.6.0)

fs 2.1.0 2026-04-18 [1] RSPM

generics 0.1.4 2025-05-09 [1] RSPM

gert 2.3.1 2026-01-11 [1] RSPM

gh 1.5.0 2025-05-26 [1] RSPM

git2r 0.36.2 2025-03-29 [1] RSPM

gitcreds 0.1.2 2022-09-08 [1] RSPM

glue 1.8.1 2026-04-17 [1] RSPM

graphics * 4.6.0 2026-04-24 [2] local

grDevices * 4.6.0 2026-04-24 [2] local

grid 4.6.0 2026-04-24 [2] local

highr 0.12 2026-03-06 [1] RSPM

hms 1.1.4 2025-10-17 [1] RSPM

htmltools 0.5.9 2025-12-04 [1] RSPM

htmlwidgets 1.6.4 2023-12-06 [1] RSPM

httptest2 1.2.2 2025-11-16 [1] RSPM

httpuv 1.6.17 2026-03-18 [1] RSPM

httr 1.4.8 2026-02-13 [1] RSPM

httr2 1.2.2 2025-12-08 [1] RSPM

ini 0.3.1 2018-05-20 [1] RSPM

janitor 2.2.1 2024-12-22 [1] RSPM

jquerylib 0.1.4 2021-04-26 [1] RSPM

jsonlite 2.0.0 2025-03-27 [1] RSPM

KernSmooth 2.23-26 2025-01-01 [2] CRAN (R 4.6.0)

knitr 1.51 2025-12-20 [1] RSPM

later 1.4.8 2026-03-05 [1] RSPM

lattice 0.22-9 2026-02-09 [2] CRAN (R 4.6.0)

lifecycle 1.0.5 2026-01-08 [1] RSPM

littler 0.3.23 2026-04-12 [1] RSPM (R 4.6.0)

lubridate 1.9.5 2026-02-04 [1] RSPM

magick 2.9.1 2026-02-28 [1] RSPM

magrittr 2.0.5 2026-04-04 [1] RSPM

MASS 7.3-65 2025-02-28 [2] CRAN (R 4.6.0)

Matrix 1.7-5 2026-03-21 [2] CRAN (R 4.6.0)

memoise 2.0.1 2021-11-26 [1] RSPM

methods * 4.6.0 2026-04-24 [2] local

mgcv 1.9-4 2025-11-07 [2] CRAN (R 4.6.0)

mime 0.13 2025-03-17 [1] RSPM

miniUI 0.1.2 2025-04-17 [1] RSPM

nectar 0.0.0.9007 2026-05-17 [1] Github (api2r/nectar@9c6c19d)

nlme 3.1-169 2026-03-27 [2] CRAN (R 4.6.0)

nnet 7.3-20 2025-01-01 [2] CRAN (R 4.6.0)

openssl 2.4.1 2026-05-14 [1] RSPM

otel 0.2.0 2025-08-29 [1] RSPM

pak 0.9.5 2026-04-27 [1] RSPM (R 4.6.0)

parallel 4.6.0 2026-04-24 [2] local

pillar 1.11.1 2025-09-17 [1] RSPM

pkgbuild 1.4.8 2025-05-26 [1] RSPM

pkgconfig 2.0.3 2019-09-22 [1] RSPM

pkgdown 2.2.0 2025-11-06 [1] RSPM

pkgload 1.5.2 2026-04-22 [1] RSPM

praise 1.0.0 2015-08-11 [1] RSPM

prettyunits 1.2.0 2023-09-24 [1] RSPM

processx 3.9.0 2026-04-22 [1] RSPM

profvis 0.4.0 2024-09-20 [1] RSPM

promises 1.5.0 2025-11-01 [1] RSPM

ps 1.9.3 2026-04-20 [1] RSPM

purrr 1.2.2 2026-04-10 [1] RSPM

qcthat 1.1.2 2026-05-17 [1] Github (Gilead-BioStats/qcthat@d0958dc)

R6 2.6.1 2025-02-15 [1] RSPM

ragg 1.5.2 2026-03-23 [1] RSPM

rapid 0.0.0.9003 2026-05-17 [1] Github (api2r/rapid@4fd4d2a)

rappdirs 0.3.4 2026-01-17 [1] RSPM

rcmdcheck 1.4.0 2021-09-27 [1] RSPM

Rcpp 1.1.1-1.1 2026-04-24 [1] RSPM

rex 1.2.2 2026-03-28 [1] RSPM

rlang 1.2.0 2026-04-06 [1] RSPM

rmarkdown 2.31 2026-03-26 [1] RSPM

roxygen2 8.0.0 2026-05-01 [1] RSPM

rpart 4.1.27 2026-03-27 [2] CRAN (R 4.6.0)

rprojroot 2.1.1 2025-08-26 [1] RSPM

rrapply 1.2.8 2025-11-25 [1] RSPM

rstudioapi 0.18.0 2026-01-16 [1] RSPM

rversions 3.0.0 2025-10-09 [1] RSPM

rvest 1.0.5 2025-08-29 [1] RSPM

S7 0.2.2 2026-04-22 [1] RSPM

sass 0.4.10 2025-04-11 [1] RSPM

selectr 0.5-1 2025-12-17 [1] RSPM

sessioninfo 1.2.3 2025-02-05 [1] RSPM

shiny 1.13.0 2026-02-20 [1] RSPM

snakecase 0.11.1 2023-08-27 [1] RSPM

sourcetools 0.1.7-2 2026-03-28 [1] RSPM

spatial 7.3-18 2025-01-01 [2] CRAN (R 4.6.0)

splines 4.6.0 2026-04-24 [2] local

stats * 4.6.0 2026-04-24 [2] local

stats4 4.6.0 2026-04-24 [2] local

stbl 0.3.0.9000 2026-05-17 [1] Github (wranglezone/stbl@5a38548)

stringi 1.8.7 2025-03-27 [1] RSPM

stringr 1.6.0 2025-11-04 [1] RSPM

survival 3.8-6 2026-01-16 [2] CRAN (R 4.6.0)

sys 3.4.3 2024-10-04 [1] RSPM

systemfonts 1.3.2 2026-03-05 [1] RSPM

tcltk 4.6.0 2026-04-24 [2] local

testthat 3.3.2 2026-01-11 [1] RSPM

textshaping 1.0.5 2026-03-06 [1] RSPM

tibble 3.3.1 2026-01-11 [1] RSPM

tibblify 0.4.1.9000 2026-05-17 [1] Github (wranglezone/tibblify@d600ef9)

tidyr 1.3.2 2025-12-19 [1] RSPM

tidyselect 1.2.1 2024-03-11 [1] RSPM

timechange 0.4.0 2026-01-29 [1] RSPM

tinytex 0.59 2026-03-28 [1] RSPM

tools 4.6.0 2026-04-24 [2] local

urlchecker 1.0.1 2021-11-30 [1] RSPM

usethis 3.2.1 2025-09-06 [1] RSPM

utf8 1.2.6 2025-06-08 [1] RSPM

utils * 4.6.0 2026-04-24 [2] local

vctrs 0.7.3 2026-04-11 [1] RSPM

waldo 0.6.2 2025-07-11 [1] RSPM

whisker 0.4.1 2022-12-05 [1] RSPM

withr 3.0.2 2024-10-28 [1] RSPM

xfun 0.57 2026-03-20 [1] RSPM

xml2 1.5.2 2026-01-17 [1] RSPM

xopen 1.0.1 2024-04-25 [1] RSPM

xtable 1.8-8 2026-02-22 [1] RSPM

yaml 2.3.12 2025-12-10 [1] RSPM

zip 2.3.3 2025-05-13 [1] RSPM

[1] /usr/local/lib/R/site-library

[2] /usr/local/lib/R/library

[3] /__w/_temp/Library

  • ── Packages attached to the search path.

──────────────────────────────────────────────────────────────────────────────

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 16, 2026 •
edited
Loading

{qcthat} Reports

PR-Associated Issues

█ A qcthat issue test matrix with 0 milestones, 0 issues, and 0 tests 
# Issue state: 📥 = open, ☑️ = closed (completed), ⛔ = closed (won't fix)
# Test disposition: ✅ = passed, ❌ = failed, 🚫 = skipped
🙈 1 issue with label "qcthat-nocov" was ignored

Completed Issues

✅ A qcthat issue test matrix with 3 milestones, 11 issues, and 21 tests 
├─█─Milestone: v0.1.0 (4 issues, 3 tests)
│ ├─☑️─Feature 35: Create testthat/setup.R
│ │ └─✅─generate_pkg() returns a vector of created files (#15, #16, #35, #82)
│ ├─☑️─Feature 17: Auto-generate auth for api_key (query or header)
│ │ └─✅─generate_pkg() generates call function with API keys (#17, #82)
│ ├─☑️─Feature 16: Generate tests for basic call function
│ │ ├─✅─.setup_r() sets up dependencies (#16)
│ │ └─✅─generate_pkg() returns a vector of created files (#15, #16, #35, #82)
│ └─☑️─Feature 15: Auto-generate apis.guru caller from rapid
│   └─✅─generate_pkg() returns a vector of created files (#15, #16, #35, #82)
├─█─Milestone: v0.4.0 (2 issues, 2 tests)
│ ├─☑️─Infrastructure 52: Eliminate dplyr dependency
│ │ └─✅─%|% works (#52)
│ └─☑️─Infrastructure 10: Config 
│   └─✅─use_beekeeper writes a yml config (#10)
└─█─Milestone: v0.5.0 Parameter docs and type checks (5 issues, 18 tests)
  ├─☑️─Feature 85: Parameter type documentation
  │ └─✅─.compile_param_class_descriptions() uses class names (#85)
  ├─☑️─Feature 84: Header and cookie parameters
  │ └─✅─.generate_paths_file() renders header and cookie params correctly (#84, #69)
  ├─☑️─Feature 82: Separate Config Loader Function
  │ ├─✅─generate_pkg() returns a vector of created files (#15, #16, #35, #82)
  │ ├─✅─generate_pkg() generates call function with API keys (#17, #82)
  │ └─✅─generate_pkg() falls back to config file when arguments are NULL (#82)
  ├─☑️─Feature 69: Param validation 
  │ ├─✅─.params_to_validations() only includes supported checks (#69)
  │ ├─✅─.paths_need_stbl() flags actionable validations (#69)
  │ ├─✅─.paths_need_stbl() returns FALSE for empty paths (#69)
  │ ├─✅─.generate_paths_file() renders header and cookie params correctly (#84, #69)
  │ └─✅─.setup_r() can include stbl in imports (#69)
  └─☑️─Feature 65: Path file per endpoint
    ├─✅─.generate_paths() returns empty character for empty paths (#65)
    ├─✅─.generate_paths() calls correct templates for guru (#65)
    ├─✅─.generate_paths() writes correct templates for guru (#65)
    ├─✅─.generate_paths() calls correct templates for fec (#65)
    ├─✅─.generate_paths() writes correct paths.R for fec (#65)
    ├─✅─.generate_paths() writes correct paths.R for trello (#65)
    ├─✅─.generate_shared_params() returns file path for no-security API (#65)
    ├─✅─.generate_shared_params() writes correct content for no-security API (#65)
    └─✅─.generate_shared_params() writes security params for API with security (#65)
# Issue state: 📥 = open, ☑️ = closed (completed), ⛔ = closed (won't fix)
# Test disposition: ✅ = passed, ❌ = failed, 🚫 = skipped
✅ All tests passed

🟢 All issues have at least one test

🙈 5 issues with label "qcthat-nocov" were ignored

This report was generated by this GitHub Actions run.

Last updated: 2026-05-17 12:42:30 UTC

Session Info ─ Session info ───────────────────────────────────────────────────────────────

setting value

version R version 4.6.0 (2026-04-24)

os Ubuntu 24.04.4 LTS

system x86_64, linux-gnu

ui X11

language (EN)

collate en_US.UTF-8

ctype en_US.UTF-8

tz UTC

date 2026-05-17

pandoc 3.1.3 @ /usr/bin/pandoc

quarto NA

─ Packages ───────────────────────────────────────────────────────────────────

package * version date (UTC) lib source

askpass 1.2.1 2024-10-04 [1] RSPM

astgrepr 0.1.1 2025-06-07 [1] RSPM

backports 1.5.1 2026-04-03 [1] RSPM

base * 4.6.0 2026-04-24 [2] local

base64enc 0.1-6 2026-02-02 [1] RSPM

beekeeper 0.4.0.9000 2026-05-17 [1] local

boot 1.3-32 2025-08-29 [2] CRAN (R 4.6.0)

brew 1.0-10 2023-12-16 [1] RSPM

brio 1.1.5 2024-04-24 [1] RSPM

bslib 0.11.0 2026-05-16 [1] RSPM

cachem 1.1.0 2024-05-16 [1] RSPM

callr 3.7.6 2024-03-25 [1] RSPM

checkmate 2.3.4 2026-02-03 [1] RSPM

class 7.3-23 2025-01-01 [2] CRAN (R 4.6.0)

cli 3.6.6 2026-04-09 [1] RSPM

clipr 0.8.0 2022-02-22 [1] RSPM

cluster 2.1.8.2 2026-02-05 [2] CRAN (R 4.6.0)

codetools 0.2-20 2024-03-31 [2] CRAN (R 4.6.0)

commonmark 2.0.0 2025-07-07 [1] RSPM

compiler 4.6.0 2026-04-24 [2] local

covr 3.6.5 2025-11-09 [1] RSPM

crayon 1.5.3 2024-06-20 [1] RSPM

credentials 2.0.3 2025-09-12 [1] RSPM

curl 7.1.0 2026-04-22 [1] RSPM

datasets * 4.6.0 2026-04-24 [2] local

desc 1.4.3 2023-12-10 [1] RSPM

devtools 2.5.2 2026-04-30 [1] RSPM

diffobj 0.3.6 2025-04-21 [1] RSPM

digest 0.6.39 2025-11-19 [1] RSPM

docopt 0.7.2 2025-03-25 [1] RSPM (R 4.6.0)

downlit 0.4.5 2025-11-14 [1] RSPM

dplyr 1.2.1 2026-04-03 [1] RSPM

ellipsis 0.3.3 2026-04-04 [1] RSPM

emoji 16.0.0 2024-10-28 [1] RSPM

evaluate 1.0.5 2025-08-27 [1] RSPM

fansi 1.0.7 2025-11-19 [1] RSPM

fastmap 1.2.0 2024-05-15 [1] RSPM

fontawesome 0.5.3 2024-11-16 [1] RSPM

foreign 0.8-91 2026-01-29 [2] CRAN (R 4.6.0)

fs 2.1.0 2026-04-18 [1] RSPM

generics 0.1.4 2025-05-09 [1] RSPM

gert 2.3.1 2026-01-11 [1] RSPM

gh 1.5.0 2025-05-26 [1] RSPM

git2r 0.36.2 2025-03-29 [1] RSPM

gitcreds 0.1.2 2022-09-08 [1] RSPM

glue 1.8.1 2026-04-17 [1] RSPM

graphics * 4.6.0 2026-04-24 [2] local

grDevices * 4.6.0 2026-04-24 [2] local

grid 4.6.0 2026-04-24 [2] local

highr 0.12 2026-03-06 [1] RSPM

hms 1.1.4 2025-10-17 [1] RSPM

htmltools 0.5.9 2025-12-04 [1] RSPM

htmlwidgets 1.6.4 2023-12-06 [1] RSPM

httptest2 1.2.2 2025-11-16 [1] RSPM

httpuv 1.6.17 2026-03-18 [1] RSPM

httr 1.4.8 2026-02-13 [1] RSPM

httr2 1.2.2 2025-12-08 [1] RSPM

ini 0.3.1 2018-05-20 [1] RSPM

janitor 2.2.1 2024-12-22 [1] RSPM

jquerylib 0.1.4 2021-04-26 [1] RSPM

jsonlite 2.0.0 2025-03-27 [1] RSPM

KernSmooth 2.23-26 2025-01-01 [2] CRAN (R 4.6.0)

knitr 1.51 2025-12-20 [1] RSPM

later 1.4.8 2026-03-05 [1] RSPM

lattice 0.22-9 2026-02-09 [2] CRAN (R 4.6.0)

lifecycle 1.0.5 2026-01-08 [1] RSPM

littler 0.3.23 2026-04-12 [1] RSPM (R 4.6.0)

lubridate 1.9.5 2026-02-04 [1] RSPM

magick 2.9.1 2026-02-28 [1] RSPM

magrittr 2.0.5 2026-04-04 [1] RSPM

MASS 7.3-65 2025-02-28 [2] CRAN (R 4.6.0)

Matrix 1.7-5 2026-03-21 [2] CRAN (R 4.6.0)

memoise 2.0.1 2021-11-26 [1] RSPM

methods * 4.6.0 2026-04-24 [2] local

mgcv 1.9-4 2025-11-07 [2] CRAN (R 4.6.0)

mime 0.13 2025-03-17 [1] RSPM

miniUI 0.1.2 2025-04-17 [1] RSPM

nectar 0.0.0.9007 2026-05-17 [1] Github (api2r/nectar@9c6c19d)

nlme 3.1-169 2026-03-27 [2] CRAN (R 4.6.0)

nnet 7.3-20 2025-01-01 [2] CRAN (R 4.6.0)

openssl 2.4.1 2026-05-14 [1] RSPM

otel 0.2.0 2025-08-29 [1] RSPM

pak 0.9.5 2026-04-27 [1] RSPM (R 4.6.0)

parallel 4.6.0 2026-04-24 [2] local

pillar 1.11.1 2025-09-17 [1] RSPM

pkgbuild 1.4.8 2025-05-26 [1] RSPM

pkgconfig 2.0.3 2019-09-22 [1] RSPM

pkgdown 2.2.0 2025-11-06 [1] RSPM

pkgload 1.5.2 2026-04-22 [1] RSPM

praise 1.0.0 2015-08-11 [1] RSPM

prettyunits 1.2.0 2023-09-24 [1] RSPM

processx 3.9.0 2026-04-22 [1] RSPM

profvis 0.4.0 2024-09-20 [1] RSPM

promises 1.5.0 2025-11-01 [1] RSPM

ps 1.9.3 2026-04-20 [1] RSPM

purrr 1.2.2 2026-04-10 [1] RSPM

qcthat 1.1.2 2026-05-17 [1] Github (Gilead-BioStats/qcthat@d0958dc)

R6 2.6.1 2025-02-15 [1] RSPM

ragg 1.5.2 2026-03-23 [1] RSPM

rapid 0.0.0.9003 2026-05-17 [1] Github (api2r/rapid@4fd4d2a)

rappdirs 0.3.4 2026-01-17 [1] RSPM

rcmdcheck 1.4.0 2021-09-27 [1] RSPM

Rcpp 1.1.1-1.1 2026-04-24 [1] RSPM

rex 1.2.2 2026-03-28 [1] RSPM

rlang 1.2.0 2026-04-06 [1] RSPM

rmarkdown 2.31 2026-03-26 [1] RSPM

roxygen2 8.0.0 2026-05-01 [1] RSPM

rpart 4.1.27 2026-03-27 [2] CRAN (R 4.6.0)

rprojroot 2.1.1 2025-08-26 [1] RSPM

rrapply 1.2.8 2025-11-25 [1] RSPM

rstudioapi 0.18.0 2026-01-16 [1] RSPM

rversions 3.0.0 2025-10-09 [1] RSPM

rvest 1.0.5 2025-08-29 [1] RSPM

S7 0.2.2 2026-04-22 [1] RSPM

sass 0.4.10 2025-04-11 [1] RSPM

selectr 0.5-1 2025-12-17 [1] RSPM

sessioninfo 1.2.3 2025-02-05 [1] RSPM

shiny 1.13.0 2026-02-20 [1] RSPM

snakecase 0.11.1 2023-08-27 [1] RSPM

sourcetools 0.1.7-2 2026-03-28 [1] RSPM

spatial 7.3-18 2025-01-01 [2] CRAN (R 4.6.0)

splines 4.6.0 2026-04-24 [2] local

stats * 4.6.0 2026-04-24 [2] local

stats4 4.6.0 2026-04-24 [2] local

stbl 0.3.0.9000 2026-05-17 [1] Github (wranglezone/stbl@5a38548)

stringi 1.8.7 2025-03-27 [1] RSPM

stringr 1.6.0 2025-11-04 [1] RSPM

survival 3.8-6 2026-01-16 [2] CRAN (R 4.6.0)

sys 3.4.3 2024-10-04 [1] RSPM

systemfonts 1.3.2 2026-03-05 [1] RSPM

tcltk 4.6.0 2026-04-24 [2] local

testthat 3.3.2 2026-01-11 [1] RSPM

textshaping 1.0.5 2026-03-06 [1] RSPM

tibble 3.3.1 2026-01-11 [1] RSPM

tibblify 0.4.1.9000 2026-05-17 [1] Github (wranglezone/tibblify@d600ef9)

tidyr 1.3.2 2025-12-19 [1] RSPM

tidyselect 1.2.1 2024-03-11 [1] RSPM

timechange 0.4.0 2026-01-29 [1] RSPM

tinytex 0.59 2026-03-28 [1] RSPM

tools 4.6.0 2026-04-24 [2] local

urlchecker 1.0.1 2021-11-30 [1] RSPM

usethis 3.2.1 2025-09-06 [1] RSPM

utf8 1.2.6 2025-06-08 [1] RSPM

utils * 4.6.0 2026-04-24 [2] local

vctrs 0.7.3 2026-04-11 [1] RSPM

waldo 0.6.2 2025-07-11 [1] RSPM

whisker 0.4.1 2022-12-05 [1] RSPM

withr 3.0.2 2024-10-28 [1] RSPM

xfun 0.57 2026-03-20 [1] RSPM

xml2 1.5.2 2026-01-17 [1] RSPM

xopen 1.0.1 2024-04-25 [1] RSPM

xtable 1.8-8 2026-02-22 [1] RSPM

yaml 2.3.12 2025-12-10 [1] RSPM

zip 2.3.3 2025-05-13 [1] RSPM

[1] /usr/local/lib/R/site-library

[2] /usr/local/lib/R/library

[3] /__w/_temp/Library

  • ── Packages attached to the search path.

──────────────────────────────────────────────────────────────────────────────

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 16, 2026 •
edited
Loading

🌐 PR pkgdown deployed

This report was generated by this GitHub Actions run.

Last updated: 2026-05-17 12:42:23 UTC

Session Info ─ Session info ───────────────────────────────────────────────────────────────

setting value

version R version 4.6.0 (2026-04-24)

os Ubuntu 24.04.4 LTS

system x86_64, linux-gnu

ui X11

language (EN)

collate en_US.UTF-8

ctype en_US.UTF-8

tz UTC

date 2026-05-17

pandoc 3.1.3 @ /usr/bin/pandoc

quarto NA

─ Packages ───────────────────────────────────────────────────────────────────

package * version date (UTC) lib source

askpass 1.2.1 2024-10-04 [1] RSPM

astgrepr 0.1.1 2025-06-07 [1] RSPM

backports 1.5.1 2026-04-03 [1] RSPM

base * 4.6.0 2026-04-24 [2] local

base64enc 0.1-6 2026-02-02 [1] RSPM

beekeeper 0.4.0.9000 2026-05-17 [1] local

boot 1.3-32 2025-08-29 [2] CRAN (R 4.6.0)

brew 1.0-10 2023-12-16 [1] RSPM

brio 1.1.5 2024-04-24 [1] RSPM

bslib 0.11.0 2026-05-16 [1] RSPM

cachem 1.1.0 2024-05-16 [1] RSPM

callr 3.7.6 2024-03-25 [1] RSPM

checkmate 2.3.4 2026-02-03 [1] RSPM

class 7.3-23 2025-01-01 [2] CRAN (R 4.6.0)

cli 3.6.6 2026-04-09 [1] RSPM

clipr 0.8.0 2022-02-22 [1] RSPM

cluster 2.1.8.2 2026-02-05 [2] CRAN (R 4.6.0)

codetools 0.2-20 2024-03-31 [2] CRAN (R 4.6.0)

commonmark 2.0.0 2025-07-07 [1] RSPM

compiler 4.6.0 2026-04-24 [2] local

covr 3.6.5 2025-11-09 [1] RSPM

crayon 1.5.3 2024-06-20 [1] RSPM

credentials 2.0.3 2025-09-12 [1] RSPM

curl 7.1.0 2026-04-22 [1] RSPM

datasets * 4.6.0 2026-04-24 [2] local

desc 1.4.3 2023-12-10 [1] RSPM

devtools 2.5.2 2026-04-30 [1] RSPM

diffobj 0.3.6 2025-04-21 [1] RSPM

digest 0.6.39 2025-11-19 [1] RSPM

docopt 0.7.2 2025-03-25 [1] RSPM (R 4.6.0)

downlit 0.4.5 2025-11-14 [1] RSPM

dplyr 1.2.1 2026-04-03 [1] RSPM

ellipsis 0.3.3 2026-04-04 [1] RSPM

emoji 16.0.0 2024-10-28 [1] RSPM

evaluate 1.0.5 2025-08-27 [1] RSPM

fansi 1.0.7 2025-11-19 [1] RSPM

fastmap 1.2.0 2024-05-15 [1] RSPM

fontawesome 0.5.3 2024-11-16 [1] RSPM

foreign 0.8-91 2026-01-29 [2] CRAN (R 4.6.0)

fs 2.1.0 2026-04-18 [1] RSPM

generics 0.1.4 2025-05-09 [1] RSPM

gert 2.3.1 2026-01-11 [1] RSPM

gh 1.5.0 2025-05-26 [1] RSPM

git2r 0.36.2 2025-03-29 [1] RSPM

gitcreds 0.1.2 2022-09-08 [1] RSPM

glue 1.8.1 2026-04-17 [1] RSPM

graphics * 4.6.0 2026-04-24 [2] local

grDevices * 4.6.0 2026-04-24 [2] local

grid 4.6.0 2026-04-24 [2] local

here 1.0.2 2025-09-15 [1] RSPM

highr 0.12 2026-03-06 [1] RSPM

hms 1.1.4 2025-10-17 [1] RSPM

htmltools 0.5.9 2025-12-04 [1] RSPM

htmlwidgets 1.6.4 2023-12-06 [1] RSPM

httptest2 1.2.2 2025-11-16 [1] RSPM

httpuv 1.6.17 2026-03-18 [1] RSPM

httr 1.4.8 2026-02-13 [1] RSPM

httr2 1.2.2 2025-12-08 [1] RSPM

ini 0.3.1 2018-05-20 [1] RSPM

janitor 2.2.1 2024-12-22 [1] RSPM

jquerylib 0.1.4 2021-04-26 [1] RSPM

jsonlite 2.0.0 2025-03-27 [1] RSPM

KernSmooth 2.23-26 2025-01-01 [2] CRAN (R 4.6.0)

knitr 1.51 2025-12-20 [1] RSPM

later 1.4.8 2026-03-05 [1] RSPM

lattice 0.22-9 2026-02-09 [2] CRAN (R 4.6.0)

lifecycle 1.0.5 2026-01-08 [1] RSPM

littler 0.3.23 2026-04-12 [1] RSPM (R 4.6.0)

lubridate 1.9.5 2026-02-04 [1] RSPM

magick 2.9.1 2026-02-28 [1] RSPM

magrittr 2.0.5 2026-04-04 [1] RSPM

MASS 7.3-65 2025-02-28 [2] CRAN (R 4.6.0)

Matrix 1.7-5 2026-03-21 [2] CRAN (R 4.6.0)

memoise 2.0.1 2021-11-26 [1] RSPM

methods * 4.6.0 2026-04-24 [2] local

mgcv 1.9-4 2025-11-07 [2] CRAN (R 4.6.0)

mime 0.13 2025-03-17 [1] RSPM

miniUI 0.1.2 2025-04-17 [1] RSPM

nectar 0.0.0.9007 2026-05-17 [1] Github (api2r/nectar@9c6c19d)

nlme 3.1-169 2026-03-27 [2] CRAN (R 4.6.0)

nnet 7.3-20 2025-01-01 [2] CRAN (R 4.6.0)

openssl 2.4.1 2026-05-14 [1] RSPM

otel 0.2.0 2025-08-29 [1] RSPM

pak 0.9.5 2026-04-27 [1] RSPM (R 4.6.0)

parallel 4.6.0 2026-04-24 [2] local

pillar 1.11.1 2025-09-17 [1] RSPM

pkgbuild 1.4.8 2025-05-26 [1] RSPM

pkgconfig 2.0.3 2019-09-22 [1] RSPM

pkgdown 2.2.0 2025-11-06 [1] RSPM

pkgload 1.5.2 2026-04-22 [1] RSPM

praise 1.0.0 2015-08-11 [1] RSPM

prettyunits 1.2.0 2023-09-24 [1] RSPM

processx 3.9.0 2026-04-22 [1] RSPM

profvis 0.4.0 2024-09-20 [1] RSPM

promises 1.5.0 2025-11-01 [1] RSPM

ps 1.9.3 2026-04-20 [1] RSPM

purrr 1.2.2 2026-04-10 [1] RSPM

qcthat 1.1.2.9000 2026-05-17 [1] Github (Gilead-BioStats/qcthat@038f5e7)

quarto 1.5.1 2025-09-04 [1] RSPM

R6 2.6.1 2025-02-15 [1] RSPM

ragg 1.5.2 2026-03-23 [1] RSPM

rapid 0.0.0.9003 2026-05-17 [1] Github (api2r/rapid@4fd4d2a)

rappdirs 0.3.4 2026-01-17 [1] RSPM

rcmdcheck 1.4.0 2021-09-27 [1] RSPM

Rcpp 1.1.1-1.1 2026-04-24 [1] RSPM

rex 1.2.2 2026-03-28 [1] RSPM

rlang 1.2.0 2026-04-06 [1] RSPM

rmarkdown 2.31 2026-03-26 [1] RSPM

roxygen2 8.0.0 2026-05-01 [1] RSPM

rpart 4.1.27 2026-03-27 [2] CRAN (R 4.6.0)

rprojroot 2.1.1 2025-08-26 [1] RSPM

rrapply 1.2.8 2025-11-25 [1] RSPM

rstudioapi 0.18.0 2026-01-16 [1] RSPM

rversions 3.0.0 2025-10-09 [1] RSPM

rvest 1.0.5 2025-08-29 [1] RSPM

S7 0.2.2 2026-04-22 [1] RSPM

sass 0.4.10 2025-04-11 [1] RSPM

selectr 0.5-1 2025-12-17 [1] RSPM

sessioninfo 1.2.3 2025-02-05 [1] RSPM

shiny 1.13.0 2026-02-20 [1] RSPM

snakecase 0.11.1 2023-08-27 [1] RSPM

sourcetools 0.1.7-2 2026-03-28 [1] RSPM

spatial 7.3-18 2025-01-01 [2] CRAN (R 4.6.0)

splines 4.6.0 2026-04-24 [2] local

stats * 4.6.0 2026-04-24 [2] local

stats4 4.6.0 2026-04-24 [2] local

stbl 0.3.0.9000 2026-05-17 [1] Github (wranglezone/stbl@5a38548)

stringi 1.8.7 2025-03-27 [1] RSPM

stringr 1.6.0 2025-11-04 [1] RSPM

survival 3.8-6 2026-01-16 [2] CRAN (R 4.6.0)

sys 3.4.3 2024-10-04 [1] RSPM

systemfonts 1.3.2 2026-03-05 [1] RSPM

tcltk 4.6.0 2026-04-24 [2] local

testthat 3.3.2 2026-01-11 [1] RSPM

textshaping 1.0.5 2026-03-06 [1] RSPM

tibble 3.3.1 2026-01-11 [1] RSPM

tibblify 0.4.1.9000 2026-05-17 [1] Github (wranglezone/tibblify@d600ef9)

tidyr 1.3.2 2025-12-19 [1] RSPM

tidyselect 1.2.1 2024-03-11 [1] RSPM

timechange 0.4.0 2026-01-29 [1] RSPM

tinytex 0.59 2026-03-28 [1] RSPM

tools 4.6.0 2026-04-24 [2] local

urlchecker 1.0.1 2021-11-30 [1] RSPM

usethis 3.2.1 2025-09-06 [1] RSPM

utf8 1.2.6 2025-06-08 [1] RSPM

utils * 4.6.0 2026-04-24 [2] local

vctrs 0.7.3 2026-04-11 [1] RSPM

waldo 0.6.2 2025-07-11 [1] RSPM

whisker 0.4.1 2022-12-05 [1] RSPM

withr 3.0.2 2024-10-28 [1] RSPM

xfun 0.57 2026-03-20 [1] RSPM

xml2 1.5.2 2026-01-17 [1] RSPM

xopen 1.0.1 2024-04-25 [1] RSPM

xtable 1.8-8 2026-02-22 [1] RSPM

yaml 2.3.12 2025-12-10 [1] RSPM

zip 2.3.3 2025-05-13 [1] RSPM

[1] /usr/local/lib/R/site-library

[2] /usr/local/lib/R/library

[3] /__w/_temp/Library

  • ── Packages attached to the search path.

──────────────────────────────────────────────────────────────────────────────

jonthegeek
jonthegeek requested changes May 17, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@jonthegeek jonthegeek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some functions have a @returns tag in this format (Format A):

#' @returns (`character`) Parameter class descriptions.

Others are more like this (Format B):

#' @returns A glue object.

I prefer "Format A", with the tick-enclosed class name in parentheses at the start of the description, mirroring what we do for @param. Standardize the @returns tag everywhere that it appears to give the class (or classes) at the beginning of the @returns text.

I've updated .github/skills/document/SKILL.md to demonstrate this updated style.

@jonthegeek
Standardize return style
3828a75 
Agent-Logs-Url: https://github.com/api2r/beekeeper/sessions/5f5b15a2-1ceb-4b78-859c-c11f3c6ba44c

Co-authored-by: jonthegeek <33983824+jonthegeek@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 17, 2026

Some functions have a @returns tag in this format (Format A):

#' @returns (`character`) Parameter class descriptions....

Updated the @returns tags throughout the R sources to use the parenthesized type-first style and regenerated the Rd files in 3828a75.

Copilot AI requested a review from jonthegeek May 17, 2026 11:57
@jonthegeek jonthegeek marked this pull request as ready for review May 17, 2026 12:19
@jonthegeek jonthegeek requested a review from Copilot May 17, 2026 12:20
Copilot AI reviewed May 17, 2026
View reviewed changes
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds roxygen documentation to previously-undocumented internal helpers, standardizes @returns tags to start with a tick-enclosed type (matching the @param style), and centralizes parameter descriptions in .shared-params. Also splits read_config() / read_api_definition() into their own file R/read_config.R (with the corresponding test/snapshot move), renames the base_path argument of .is_pkg/.assert_is_pkg to pkg_dir, and adds ... to several S7 method implementations so they match generic signatures with @rdname aliases.

Changes:

  • Standardize all @returns tags to lead with a tick-enclosed type and document many internal helpers.
  • Centralize shared parameter docs in R/aaa-shared_params.R and rename base_path → pkg_dir in .is_pkg/.assert_is_pkg.
  • Move read_config() / read_api_definition() (plus tests and snapshots) from generate_pkg-setup.R into a dedicated R/read_config.R.

Reviewed changes

Copilot reviewed 73 out of 88 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
R/aaa-conditions.R Reformat @returns to tick-enclosed types.
R/aaa-shared_params.R Centralize many shared parameter descriptions.
R/as_bk_data.R Inherit shared params; add ... to default S7 method; add @rdname.
R/generate_pkg.R Document .generate_pkg_impl; update @returns style.
R/generate_pkg-pagination.R Add internal roxygen header.
R/generate_pkg-paths.R Document all internal helpers; add ... to S7 method.
R/generate_pkg-prepare.R Document internal generators.
R/generate_pkg-security.R Document helpers; add .../@rdname to S7 methods.
R/generate_pkg-setup.R Rename base_path→pkg_dir; remove moved read_config/read_api_definition; add .setup_r header.
R/generate_pkg-shared.R Add internal roxygen header.
R/generate_pkg-template.R Inherit shared params; document .bk_use_template_impl.
R/read_config.R New file holding read_config, .stabilize_config, read_api_definition.
R/use_beekeeper.R Document .write_rapid/.write_config; update @returns.
R/utils.R Inherit shared params; standardize @returns; rename .collapse_comma_self_equal arg to to_collapse; add ... to S7 methods of .flatten_df; document .paste0_if, .glue_pipe_brace, .to_snake.
tests/testthat/test-read_config.R New file holding the moved read_config/read_api_definition tests.
tests/testthat/test-generate_pkg-setup.R Remove the now-moved tests.
tests/testthat/_snaps/read_config.md New snapshot for read_config.
tests/testthat/_snaps/generate_pkg-setup.md Remove the moved snapshot.
.github/skills/document/SKILL.md Update return-tag examples to lead with tick-enclosed types.
man/* Regenerated Rd files (not reviewed per guideline).
Files not reviewed (15)
  • man/as_bk_data.Rd: Language not supported
  • man/dot-assert_is_pkg.Rd: Language not supported
  • man/dot-bk_use_template.Rd: Language not supported
  • man/dot-bk_use_template_impl.Rd: Language not supported
  • man/dot-collapse_comma.Rd: Language not supported
  • man/dot-collapse_comma_newline.Rd: Language not supported
  • man/dot-collapse_comma_self_equal.Rd: Language not supported
  • man/dot-collapse_quote_comma.Rd: Language not supported
  • man/dot-compile_param_class_descriptions.Rd: Language not supported
  • man/dot-describe_param_classes.Rd: Language not supported
  • man/dot-extract_params_by_location.Rd: Language not supported
  • man/dot-flatten_df.Rd: Language not supported
  • man/dot-flatten_params_df.Rd: Language not supported
  • man/dot-generate_pagination.Rd: Language not supported
  • man/dot-generate_paths.Rd: Language not supported

Comment thread R/generate_pkg-setup.R
@jonthegeek jonthegeek enabled auto-merge (squash) May 17, 2026 12:30
@jonthegeek jonthegeek disabled auto-merge May 17, 2026 12:32
@jonthegeek jonthegeek enabled auto-merge (squash) May 17, 2026 12:40
@jonthegeek jonthegeek merged commit a0274ec into main May 17, 2026
10 checks passed
@jonthegeek jonthegeek deleted the copilot/document-internal-functions branch May 17, 2026 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

+1 more reviewer

@jonthegeek jonthegeek jonthegeek approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@jonthegeek jonthegeek

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document internal functions

3 participants

@jonthegeek