dp-labs/dora

[Documentation] Update current Rustdoc content and add examples for doctest

Open

#212 opened on Dec 29, 2024

View on GitHub
 (2 comments) (2 reactions) (1 assignee)WebAssembly (5 forks)auto 404
documentationgood first issuehelp wantedtest

Repository metrics

Stars
 (24 stars)
PR merge metrics
 (PR metrics pending)

Description

Migrate no_check to ignore or no_run

Contributor guide

Research direction
Find all instances of `no check` in Rustdoc files and update them to `ignore` or `no run`. After updating, verify that doctests still pass and add new doctest examples if needed.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90