Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix markdown reported by clippy in docs #1500

Merged
merged 7 commits into from
Sep 30, 2024

Conversation

Br1ght0ne
Copy link
Contributor

Summary

While running cargo clippy, I get a few warnings about Markdown formatting in our doc comments (see the dropdown for warning text). This should both clean my cargo output and guarantee proper formatting on docs.rs.

excerpt of `cargo clippy` output
warning: doc list item missing indentation
  --> packages/fuels-code-gen/src/program_bindings/abigen.rs:34:9
   |
34 |     /// for, and of what nature (Contract, Script or Predicate).
   |         ^
   |
   = help: if this is supposed to be its own paragraph, add a blank line
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
   = note: `#[warn(clippy::doc_lazy_continuation)]` on by default
help: indent this line
   |
34 |     ///   for, and of what nature (Contract, Script or Predicate).
   |         ++

warning: doc list item missing indentation
   --> packages/fuels-code-gen/src/program_bindings/abigen.rs:154:9
    |
154 |     /// generated.
    |         ^
    |
    = help: if this is supposed to be its own paragraph, add a blank line
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
    |
154 |     ///   generated.
    |         ++

warning: `fuels-code-gen` (lib) generated 2 warnings
warning: doc list item missing indentation
   --> packages/fuels-programs/src/calls/call_handler.rs:297:9
    |
297 |     /// Note that this is a builder method, i.e. use it as a chain:
    |         ^
    |
    = help: if this is supposed to be its own paragraph, add a blank line
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
    = note: `#[warn(clippy::doc_lazy_continuation)]` on by default
help: indent this line
    |
297 |     ///   Note that this is a builder method, i.e. use it as a chain:
    |         ++

warning: `fuels-programs` (lib) generated 1 warning

Checklist

  • All changes are covered by tests (or not applicable)
  • All changes are documented (or not applicable)
  • I reviewed the entire PR myself (preferably, on GH UI)
  • I described all Breaking Changes (or there's none)

@Br1ght0ne Br1ght0ne added documentation Improvements or additions to documentation tech-debt Improves code quality or safety labels Sep 2, 2024
@Br1ght0ne Br1ght0ne self-assigned this Sep 2, 2024
@calldelegation
Copy link
Contributor

Hello @Br1ght0ne can we change the title to chore: fix markdown reported by clippy in docs so the release notes script can pick it up on the next release please? 😄

@Br1ght0ne
Copy link
Contributor Author

@calldelegation Sure! Should I/we avoid scoping (parenthesised parts) altogether in the future?

@Br1ght0ne Br1ght0ne changed the title chore(docs): fix markdown reported by clippy chore: fix markdown reported by clippy in docs Sep 3, 2024
@calldelegation
Copy link
Contributor

@Br1ght0ne yea the titles should be chore, feat, or fix | chore!, feat!, or fix!
https://github.com/FuelLabs/fuels-rs/blob/master/scripts/change-log/src/get_full_changelog.rs#L159-#L175

@digorithm
Copy link
Member

@Br1ght0ne, can you please sync the branch?

@Br1ght0ne Br1ght0ne enabled auto-merge (squash) September 12, 2024 15:12
@Br1ght0ne Br1ght0ne merged commit fa6ee10 into master Sep 30, 2024
41 of 44 checks passed
@Br1ght0ne Br1ght0ne deleted the oleksii/clippy-docs-markdown branch September 30, 2024 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation tech-debt Improves code quality or safety
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants