oxidecomputer / oxidecomputer/iddqd

Add examples for daft implementations

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

Nobody has claimed this yet.

Dominant language
Rust
Stars
405
Forks
15
Avg merge
14m
Merged PRs (30d)
25

Description

It would be nice to have example doctests for all the daft implementations:

  • create diffs
  • for bijective and trijective maps, diff by particular keys

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

Locate the Rust implementations covered by this issue and review their existing doctest coverage. Add examples for creating diffs and, for bijective and trijective maps, diffing by particular keys; done means the requested examples are present for all implementations and pass as doctests.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.