Fix docs of arm acle intrinsics
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 694
- Forks
- 336
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 9
Description
The top-level module docs should just document which subset of the intrinsics are implemented in each module (e.g. DSP intrinsics), ideally with a link to the spec of those intrinsics, instead of containing lists of intrinsics and what not.
The docs of the intrinsics use [0] and [1] to denote the arguments, but then they use a and b as argument names. The doc comments should only refer to a and b in that case.
cc @japaric
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the top-level module documentation and the ARM ACLE intrinsic doc comments mentioned in the issue, then compare the implemented module subsets with the relevant ACLE specification. Done means module docs describe only their supported intrinsic subsets with spec links, and intrinsic comments consistently refer to arguments as a and b rather than [0] and [1].
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100