Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

[fix lint warnings: NFTs pallet] fix clippy::missing_docs_in_private_items warnings #14610

Merged

Conversation

sacha-l
Copy link
Contributor

@sacha-l sacha-l commented Jul 21, 2023

This PR fixes the 66 warnings emitted by running cargo clippy -- -A clippy::all -W clippy::missing_docs_in_private_items --no-deps in the NFTs pallet crate. It adds the missing docs for the pallet's helper functions and associated modules.

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

@sacha-l sacha-l added A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). I6-documentation Documentation needs fixing, improving or augmenting. B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit labels Jul 21, 2023
@sacha-l sacha-l marked this pull request as ready for review July 25, 2023 12:35
@sacha-l sacha-l requested a review from jsidorenko as a code owner July 25, 2023 12:35
@sacha-l
Copy link
Contributor Author

sacha-l commented Aug 14, 2023

bot rebase

@paritytech-processbot
Copy link

Rebased

@sacha-l
Copy link
Contributor Author

sacha-l commented Aug 15, 2023

bot fmt

@command-bot
Copy link

command-bot bot commented Aug 15, 2023

@sacha-l https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/3388817 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". 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 31-97bd6460-ee44-467c-b32b-b01347cb3ee2 to cancel this command or bot cancel to cancel all commands in this pull request.

@command-bot
Copy link

command-bot bot commented Aug 15, 2023

@sacha-l Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/3388817 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/3388817/artifacts/download.

Sacha Lansky and others added 2 commits August 15, 2023 16:00
Co-authored-by: Squirrel <gilescope@gmail.com>
@sacha-l
Copy link
Contributor Author

sacha-l commented Aug 16, 2023

bot merge

@paritytech-processbot paritytech-processbot bot merged commit c5855f4 into master Aug 16, 2023
49 checks passed
@paritytech-processbot paritytech-processbot bot deleted the sl/fix-nfts-missing-docs-private-items-lint branch August 16, 2023 09:54
Ank4n pushed a commit that referenced this pull request Aug 20, 2023
…items warnings (#14610)

* add docs for impl_codec_bitflags

* add missing docs for type aliases

* add docs to transfer module

* add docs for settings module

* add docs to roles module

* add docs to metadata module

* add docs to migration module

* add missing docs to feature library

* methods not functions

* add docs to lock module

* add docs to attributes module

* add docs to create_delete_item module

* add docs for create_delete_collection module

* add docs to buy_sell module

* add missing doc for buy_sell module

* add docs to atomic_swap module

* add docs to atomic_swap module

* add docs for approvals module

* run cargo fmt

* Fix issues with multi-line comments

* Apply suggestions from code review

Co-authored-by: Jegor Sidorenko <5252494+jsidorenko@users.noreply.github.com>

* update from review

* fmt

* update from review

* remove bitflag example

* ".git/.scripts/commands/fmt/fmt.sh"

* Apply suggestions from code review

Co-authored-by: Squirrel <gilescope@gmail.com>

* add note about pallet features

---------

Co-authored-by: Jegor Sidorenko <jegor@parity.io>
Co-authored-by: Jegor Sidorenko <5252494+jsidorenko@users.noreply.github.com>
Co-authored-by: parity-processbot <>
Co-authored-by: Squirrel <gilescope@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit I6-documentation Documentation needs fixing, improving or augmenting.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants