cmars/stigmerge

Rust docs

Open

#37 opened on Mar 31, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (6 forks)auto 404
good first issuehelp wanted

Repository metrics

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

Description

Now that docs.rs is building... rustdoc comments would be :fire:

Contributor guide

Research direction
Identify public functions and types without doc comments in the codebase, then write clear rustdoc comments explaining their purpose and usage.
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
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90