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

[fix docs compiler warnings] Glutton pallet #14664

Merged
merged 4 commits into from
Aug 1, 2023

Conversation

sacha-l
Copy link
Contributor

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

This PR fixes 7 missing doc warnings in the Glutton pallet

@sacha-l sacha-l added A0-please_review Pull request needs code review. 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 28, 2023
@sacha-l sacha-l requested review from gilescope, ggwpez, NachoPal and a team July 28, 2023 04:12
Comment on lines 82 to +84
/// The computation limit has been updated.
ComputationLimitSet { compute: FixedU64 },
ComputationLimitSet {
/// The computation limit.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Annoying that we say "compute" everywhere else and "computation" here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep agree. Right now the goal is to fix the warnings. We may want to do a pass on renaming some the variables to be more accurate in a follow-up. For this one, it makes more sense to use the term "computation" over "compute" imo.

frame/glutton/src/lib.rs Outdated Show resolved Hide resolved
@ggwpez
Copy link
Member

ggwpez commented Jul 28, 2023

Please also add #![deny(missing_docs)], otherwise this will get out-dated.

Sacha Lansky and others added 2 commits July 28, 2023 16:23
@sacha-l
Copy link
Contributor Author

sacha-l commented Aug 1, 2023

bot merge

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. 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.

4 participants