linebender / linebender/fearless_simd

Convert unit tests into generated doctests

Open
#267 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
457
Forks
30
Avg merge
1d 10h
Merged PRs (30d)
25

Description

We have a great deal of handwritten and LLM-generated unit tests, but the test coverage is somewhat spotty: they are spread across at least 3 different files and are rather disorganized, so the coverage is quite difficult to track.

At the same time the SIMD operations have no usage examples, just brief doc string descriptions.

We might be able to slay two birds with one stone by converting the test suite into doctests on the relevant methods. This moves the tests onto the methods themselves and makes coverage far easier to track, and has them double as usage examples in documentation.

Contributor guide

No contributing guide indexed for this repository

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

Start by locating the handwritten and generated unit tests across the three or more test files, then identify the SIMD operation methods whose doc strings lack examples. Convert relevant coverage into doctests attached to those methods, preserving the existing test behavior and adding usage examples. Done means the tests run as doctests and coverage is easier to track from the methods themselves.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, testing
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.