canonical / canonical/fpgad

tests: we should convert ignored doctests to real doctests where possible

Open
#169 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
11
Forks
0
PR merge metrics
No merged PRs in 30d

Description

many of the existing docstrings are
> \`\`\` rust,ignore

or
> \`\`\`rust,no_run

we should make these compilable in all cases, and runnable where reasonable

Contributor guide

No contributing guide indexed for this repository

Research direction

Search the repository's Rust docstrings for examples marked `rust,ignore` or `rust,no_run`. Review each example to determine whether it can compile and run safely, then convert applicable cases and verify that the doctest suite passes. Done means eligible examples are no longer unnecessarily ignored while examples requiring `no_run` remain appropriately handled.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.