Missing panic and errors docs

Open Beginner friendly
#628 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
rust
Domain
documentation

Research direction

First, check that pull request #623 is merged and understand the changes it introduced. Then, locate the project's lint configuration (likely in a file like clippy.toml or Cargo.toml). Enable the missing_errors_doc and missing_panics_doc lints there. After enabling, run cargo clippy to see which functions now need documentation and add the missing /// # Errors and /// # Panics doc comments accordingly.

Written by the indexing model from the issue text.

Description

CI documentation

Enable the missing_errors_doc and missing_panics_doc lints once #623 is merged.

Dominant language
Rust
Stars
105
Forks
139
Avg merge
1d 22h
Merged PRs (30d)
61

Contributor guide

Open the contributing guide

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.

More from 0xMiden/node

All issues in 0xMiden/node

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.