rstudio/plumber

document that local variables are ok

Open

#330 opened on Nov 2, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)R (257 forks)batch import
difficulty: novicedocseffort: lowhelp wanted

Repository metrics

Stars
 (1,437 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The router below works as expected.

#* @get /a
(function(){
  cat("sourced!\n")
  function() {
    valueA
  }
})()

#* @get /b
function() {
  valueA
}

valueA <- 4

It should be added to the documentation here: https://www.rplumber.io/docs/runtime.html#environments

Ref: https://github.com/trestletech/plumber/issues/329

Contributor guide

Research direction
Look at the plumber documentation page for environments and add an example showing that local variables are preserved across request handlers. See the linked issue for the example code.
Tech stack
r
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90