WebAssembly / WebAssembly/spec

Change direction in wording around stack unwinding

Open
#1,781 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
WebAssembly
Stars
3.5k
Forks
539
Avg merge
2d 1h
Merged PRs (30d)
13

Description

The original sentence reads:

Taking a branch unwinds the operand stack up to the height where the targeted structured control instruction was entered.

However, usually one speaks of the top of the stack as where new values are pushed to/popped from. Following that metaphor when talking about unwinding, unwinding goes down in the stack. Hence the following proposal:

Taking a branch unwinds the operand stack updown to the height where the targeted structured control instruction was entered.

https://github.com/WebAssembly/spec/blob/bbe955d1fab3d7f74f4e9d19d77df85e482c397f/document/core/syntax/instructions.rst?plain=1#L691C45-L691C48

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open document/core/syntax/instructions.rst at the linked wording around line 691 and review the surrounding discussion of operand-stack unwinding. Change the direction word from “up” to “down” if the proposal matches the specification’s intended metaphor. Done means the sentence uses the agreed wording and the surrounding text remains consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
wasm
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.