Skip to content

docs: wrap long line in mod_puls_routing example to fix Rd line-width… - #14

Merged
danmcgraw94 merged 1 commit into
mainfrom
fix/roxygen-examples-and-vignette
Apr 20, 2026
Merged

docs: wrap long line in mod_puls_routing example to fix Rd line-width…#14
danmcgraw94 merged 1 commit into
mainfrom
fix/roxygen-examples-and-vignette

Conversation

@danmcgraw94

Copy link
Copy Markdown
Collaborator

Summary

Closes #3.

During investigation of Issue #3, three of the four reported items were found to be environmental on the reviewer's side (stale installed package) rather than actual code bugs:

  • rfaR / peakStages — no reference to peakStages in current package code
  • scale_hydrograph() — example already uses JMD data, runs cleanly under example()
  • mod_puls_routing() — example is self-contained, runs cleanly under example()
  • rfaR-Realization-Conceptual.Rmd vignette — builds cleanly under devtools::build_vignettes()

The one real issue was an R CMD check NOTE on mod_puls_routing.Rd flagging a line over 100 characters in the \examples block.

Changes

Wrapped the long line in mod_puls_routing()'s @examples block to stay under 100 characters.

Testing

  • R CMD check now reports 0 errors, 0 warnings, 0 notes
  • example("mod_puls_routing") runs cleanly end-to-end

@danmcgraw94
danmcgraw94 merged commit d747f90 into main Apr 20, 2026
6 checks passed
@danmcgraw94
danmcgraw94 deleted the fix/roxygen-examples-and-vignette branch April 20, 2026 20:18
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.

Fix failing roxygen examples and broken conceptual vignette

1 participant