pyro-ppl/pyro

Incorrect stack terminology in Poutine and minipyro.py

Open

#3088 aperta il 13 mag 2022

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (981 fork)batch import
documentationhelp wanted

Metriche repository

Star
 (8211 star)
Metriche merge PR
 (Merge medio 10g 19h) (1 PR mergiata in 30 g)

Descrizione

The Poutine example page and the minipyro.py example script flip the standard terminology of the stack data structure. One adds and removes from the top of the stack, but in these pages this is flipped. As pedagogical resources, this inverted terminology adds unnecessary confusion.

For example, when iterating over the stack in minipyro.py:

PYRO_STACK is reversed so that effect handlers higher in the stack are first applied.

and in http://pyro.ai/examples/effect_handlers.html#Interlude:-the-global-Messenger-stack:

Messenger.__enter__ appends a Messenger to the end (the bottom) of the global handler stack

Guida contributor

Direzione di ricerca
Esamina la pagina degli esempi di Poutine (effect handlers.html) e lo script di esempio minipyro.py. La terminologia per le operazioni sullo stack (top/bottom) è invertita. Correggi i commenti e le descrizioni per allinearli alla terminologia standard dello stack. Controlla la pagina di esempio collegata e lo script nel repository.
Tech stack
python
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.
Datata
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