workflows: linter does not lint docstrings

Open Beginner friendly
#170 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

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<String> where each element is an overlay name from the input ...
   |          ^^^^^^^^
   |
Dominant language
Rust
Stars
11
Forks
0
No merged PRs in 30d

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.

More from canonical/fpgad

All issues in canonical/fpgad

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.