canonical / canonical/fpgad

workflows: linter does not lint docstrings

Open Beginner friendly
#170 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

The linters and pre-commit configs do not run the `cargo doc` and fail on docstring formatting issues like
```
warning: unclosed HTML tag `String`
--> cli/src/status.rs:43:10
|
43 | /// A Vec where each element is an overlay name from the input ...
| ^^^^^^^^
|
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Inspect the repository's workflow, linter, and pre-commit configuration, then run the existing checks and `cargo doc` to reproduce the warning shown for `cli/src/status.rs`. Update the relevant configuration so documentation warnings such as unclosed HTML tags are checked automatically, and confirm the checks fail on the example issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
ci-cd, tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.