pyro-ppl/pyro

Incorrect stack terminology in Poutine and minipyro.py

Open

#3,088 建立於 2022年5月13日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Python (8,211 star) (981 fork)batch import
documentationhelp wanted

描述

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

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
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.