pyro-ppl/pyro

Incorrect stack terminology in Poutine and minipyro.py

Open

#3,088 opened on May 13, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (8,211 stars) (981 forks)batch import
documentationhelp wanted

Description

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Look at the Poutine example page (effect handlers.html) and the minipyro.py example script. The terminology for stack operations (top/bottom) is inverted. Fix the comments and descriptions to align with standard stack terminology. Check the linked example page and the script in the repository.