rstudio/plumber

document that local variables are ok

Aperta

#330 aperta il 2 nov 2018

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)R (257 fork)batch import
difficulty: novicedocseffort: lowhelp wanted

Metriche repository

Star
 (1437 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
La richiesta dell'issue è di aggiungere documentazione sulle variabili locali nelle route di plumber, facendo riferimento all'esempio funzionante nel corpo dell'issue. La pagina di destinazione è https://www.rplumber.io/docs/runtime.html#environments. L'esempio mostra che valueA è accessibile all'interno di entrambi gli endpoint. La documentazione dovrebbe notare che le variabili locali definite al di fuori delle funzioni sono disponibili nei gestori di route. Vedi anche l'issue #329 citato per il contesto.
Tech stack
r
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90