Skip to content

docs: add doctest for ForwardStoreToLoad pass#2985

Closed
MukundaKatta wants to merge 1 commit into
google:mainfrom
MukundaKatta:docs/add-operation-balancer-doctest
Closed

docs: add doctest for ForwardStoreToLoad pass#2985
MukundaKatta wants to merge 1 commit into
google:mainfrom
MukundaKatta:docs/add-operation-balancer-doctest

Conversation

@MukundaKatta
Copy link
Copy Markdown

Closes #2014.

Adds a doctest.mlir for the --forward-store-to-load pass and wires
the (* example filepath=... *) directive in ForwardStoreToLoad.td
so the example shows up on the pass docs page at heir.dev.

The example shows the core behavior: a store immediately followed by a
load at the same index is simplified so the load is replaced by the
stored value directly.

Note: OperationBalancer already has a doctest (added in
5a6890d), so I picked the next uncovered pass instead.

Adds tests/Transforms/forward_store_to_load/doctest.mlir with a simple
store-forwarding example, and wires the doctest directive in
ForwardStoreToLoad.td so the pass page on heir.dev shows the example.

Part of google#2014.
@j2kun
Copy link
Copy Markdown
Collaborator

j2kun commented May 25, 2026

Hi @MukundaKatta, welcome to HEIR. Please see the contributing policy: https://github.com/google/heir/blob/main/CONTRIBUTING.md#L28

If you're excited about homomorphic encryption, we'd welcome you to attend one of our regular meetings and we can discuss a starter project. See the calendar at https://heir.dev/community

@j2kun j2kun closed this May 25, 2026
@google google locked and limited conversation to collaborators May 25, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Convert and add more documentation examples from LIT tests

2 participants