paritytech / substrate

Substrate: The platform for blockchain innovators
Apache License 2.0
8.39k stars 2.65k forks source link

[fix lint warnings: Uniques pallet] fix clippy::doc_markdown warnings #14592

Closed sacha-l closed 1 year ago

sacha-l commented 1 year ago

This PR fixes the 481 warnings emitted by the doc_markdown lint for the Uniques pallet.

Note: These lint warnings should no longer happen for newly generated weight files thanks to #14535.

This is part of an ongoing effort from the https://github.com/orgs/paritytech/teams/devrel team to improve developer experience.

ggwpez commented 1 year ago

bot bench $ pallet dev pallet_uniques

Actually running the benches should also fix it - and tell us if my fix was good 😄

command-bot[bot] commented 1 year ago

@ggwpez https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/3204420 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" pallet dev pallet_uniques. Check out https://gitlab.parity.io/parity/mirrors/substrate/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 12-1a3ed205-d0c9-4c0c-a5fd-df85ab0e5318 to cancel this command or bot cancel to cancel all commands in this pull request.

command-bot[bot] commented 1 year ago

@ggwpez Command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" pallet dev pallet_uniques has finished. Result: https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/3204420 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/3204420/artifacts/download.

sacha-l commented 1 year ago

@sacha-l can you please run the linter again? The weights got updated by the bot now.

Ran it locally - there's still some warnings:

warning: item in documentation is missing backticks
  --> frame/uniques/src/weights.rs:18:31
   |
18 | //! Autogenerated weights for pallet_uniques
   |                               ^^^^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
   = note: requested on the command line with `-W clippy::doc-markdown`
help: try
   |
18 | //! Autogenerated weights for `pallet_uniques`
   |                               ~~~~~~~~~~~~~~~~

warning: backticks are unbalanced
  --> frame/uniques/src/weights.rs:20:1
   |
20 | / //! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 4.0.0-dev
21 | | //! DATE: 2023-07-17, STEPS: `50`, REPEAT: `20`, LOW RANGE: `[]`, HIGH RANGE: `[]`
22 | | //! WORST CASE MAP SIZE: `1000000`
23 | | //! HOSTNAME: `runner-gghbxkbs-project-145-concurrent-0`, CPU: `Intel(R) Xeon(R) CPU @ 2.60GHz`
24 | | //! EXECUTION: ``, WASM-EXECUTION: `Compiled`, CHAIN: `Some("dev")`, DB CACHE: `1024`
   | |_____________________________________________________________________________________^
   |
   = help: a backtick may be missing a pair
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown

warning: item in documentation is missing backticks
  --> frame/uniques/src/weights.rs:50:33
   |
50 | /// Weight functions needed for pallet_uniques.
   |                                 ^^^^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
   |
50 | /// Weight functions needed for `pallet_uniques`.
   |                                 ~~~~~~~~~~~~~~~~

warning: item in documentation is missing backticks
  --> frame/uniques/src/weights.rs:80:17
   |
80 | /// Weights for pallet_uniques using the Substrate node and recommended hardware.
   |                 ^^^^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
help: try
   |
80 | /// Weights for `pallet_uniques` using the Substrate node and recommended hardware.
   |                 ~~~~~~~~~~~~~~~~

warning: `pallet-uniques` (lib) generated 4 warnings (run `cargo clippy --fix --lib -p pallet-uniques` to apply 3 suggestions)
ggwpez commented 1 year ago

Ran it locally - there's still some warnings:

What command are you running?
If you want to have this also working in the future then we need to integrate it into the CI, otherwise someone will silently break it.
Updating these files manually does not really work, since they auto-generated, so any change will be over-written eventually.

sacha-l commented 1 year ago

What command are you running?

cargo clippy -- -A clippy::all -W clippy::doc_markdown --no-deps

Updating these files manually does not really work, since they auto-generated, so any change will be over-written eventually.

Yes - shouldn't we update the template with the missing backticks?

ggwpez commented 1 year ago

bot bench $ pallet dev pallet_uniques

command-bot[bot] commented 1 year ago

@ggwpez https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/3223649 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" pallet dev pallet_uniques. Check out https://gitlab.parity.io/parity/mirrors/substrate/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 23-87ba5193-bc7f-480a-983b-5ac826242ccb to cancel this command or bot cancel to cancel all commands in this pull request.

command-bot[bot] commented 1 year ago

@ggwpez Command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" pallet dev pallet_uniques has finished. Result: https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/3223649 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/3223649/artifacts/download.

sacha-l commented 1 year ago

bot merge