diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2023-05-01 11:35:29 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2023-05-01 11:35:29 -0400 |
| commit | 7746d57ae08adfd1a27bdbf3deb1d664c546b86c (patch) | |
| tree | c08de252a95ec399c687eec919107bc690e10e3e /docs/dev | |
| parent | 6c81f0f746e8a0dc581d9c3b4aebbeaeecf3df84 (diff) | |
small tweaks to visitors docs
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/bnil-overview.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/dev/bnil-overview.md b/docs/dev/bnil-overview.md index b20e7490..31fd7404 100644 --- a/docs/dev/bnil-overview.md +++ b/docs/dev/bnil-overview.md @@ -121,17 +121,18 @@ Make sure to also check out the specifics of each IL level for more details: [LL ## Visitors -A number of visit APIs are available on both the IL function object and the il instructions themselves. There are 3 variants: +A number of visit APIs are available on both the IL function object and the IL instructions themselves. There are 3 variants: -* `visit` - visits just the instructions themselves not the operands of the instruction. +* `visit` - visits just the instructions not the operands of the instruction. * `visit_all` - visits the instructions and their operands * `visit_operands` - visits just the operands -The visitor receives 4 operands. -* operand_name - name of the current thing being visited (i.e. src, dest, value) -* inst - the current instruction or operand being visited -* instr_type_name - the name of instr's type -* parent - the parent instruction to inst +The visitor receives 4 operands: + +1. operand_name - name of the current thing being visited (i.e. src, dest, value) +1. inst - the current instruction or operand being visited +1. instr_type_name - the name of instruction's type +1. parent - the parent instruction ```python >>> def visitor(operand_name, inst, instr_type_name, parent): |