numba / numba/llvmlite

Note on emitting assembly

Open
#545 0 comments 2 reactions 0 assignees View on GitHub
doc Easy
Dominant language
Python
Stars
2.3k
Forks
372
Avg merge
3d 2h
Merged PRs (30d)
10

Description

This is a small thing but I spent quite some time in the docs looking for how to get the machine assembly (because I would like to check for specific instructions) before remembering that Numba can do it. Poking around in Numba revealed the API, I saw that a simple modification of the llvmlite examples,
```python
asm = str(target_machine.emit_assembly(mod))
```
was enough. It could be nice to mention that or leave this issue here so others can find it if they look.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the llvmlite examples and checking how target_machine and mod are introduced. Document that target_machine.emit_assembly(mod), converted to a string, provides machine assembly for inspecting instructions; done when the relevant docs mention this API.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.