rstudio/plumber

document that local variables are ok

Open

#330 建立於 2018年11月2日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)R (1,437 star) (257 fork)batch import
difficulty: novicedocseffort: lowhelp wanted

描述

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

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
R programmingPlumber basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
The issue requests adding documentation about local variables in plumber routes, referencing the working example in the issue body. The target page is https://www.rplumber.io/docs/runtime.html#environments. The example shows that valueA is accessible inside both endpoints. The documentation should note that local variables defined outside functions are available in route handlers. See also the referenced issue #329 for context.