rstudio/plumber

document that local variables are ok

Open

#330 ouverte le 2 nov. 2018

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)R (257 forks)batch import
difficulty: novicedocseffort: lowhelp wanted

Métriques du dépôt

Stars
 (1 437 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Cette demande d'issue propose d'ajouter une documentation sur les variables locales dans les routes plumber, en référence à l'exemple fonctionnel dans le corps de l'issue. La page cible est https://www.rplumber.io/docs/runtime.html#environments. L'exemple montre que valueA est accessible à l'intérieur des deux endpoints. La documentation devrait indiquer que les variables locales définies en dehors des fonctions sont disponibles dans les gestionnaires de route. Voir également l'issue #329 référencée pour le contexte.
Stack technique
r
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90