rstudio/plumber

document that local variables are ok

Open

#330 geöffnet am 2. Nov. 2018

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)R (257 Forks)batch import
difficulty: novicedocseffort: lowhelp wanted

Repository-Metriken

Stars
 (1.437 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Das Issue fordert die Ergänzung der Dokumentation zu lokalen Variablen in plumber Routen und verweist auf das funktionierende Beispiel im Issue Text. Die Zielseite ist https://www.rplumber.io/docs/runtime.html#environments. Das Beispiel zeigt, dass valueA innerhalb beider Endpunkte zugänglich ist. Die Dokumentation sollte vermerken, dass außerhalb von Funktionen definierte lokale Variablen in den Routen Handlern verfügbar sind. Siehe auch das referenzierte Issue #329 für den Kontext.
Tech Stack
r
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90