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

contracts: Improve documentation of lazy deletion config #10582

Merged
merged 5 commits into from
Jan 6, 2022

Conversation

athei
Copy link
Member

@athei athei commented Jan 4, 2022

Just added some better documentation for two items after receiving some questions about them.

@athei athei added 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 labels Jan 4, 2022
@athei athei requested review from ascjones, cmichi and HCastano January 4, 2022 16:22
@athei athei force-pushed the at-contract-docs branch from 6864f43 to c644a41 Compare January 4, 2022 16:23
Copy link
Contributor

@sacha-l sacha-l left a comment

Choose a reason for hiding this comment

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

A couple easy edits caught my eye when I saw this. 😃

frame/contracts/src/lib.rs Outdated Show resolved Hide resolved
frame/contracts/src/lib.rs Outdated Show resolved Hide resolved
frame/contracts/src/lib.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@ascjones ascjones left a comment

Choose a reason for hiding this comment

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

LGTM

frame/contracts/src/lib.rs Outdated Show resolved Hide resolved
@@ -255,10 +255,29 @@ pub mod pallet {
type CallStack: smallvec::Array<Item = Frame<Self>>;

/// The maximum number of tries that can be queued for deletion.
Copy link
Contributor

Choose a reason for hiding this comment

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

Slightly ambiguous as "tries" could possibly be interpreted as "attempts" on first reading. Maybe fully qualify e.g. "contract storage tries"

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point. Changed the wording.

@athei
Copy link
Member Author

athei commented Jan 6, 2022

bot merge

@paritytech-processbot
Copy link

Waiting for commit status.

@paritytech-processbot paritytech-processbot bot merged commit 2316fc9 into master Jan 6, 2022
@paritytech-processbot paritytech-processbot bot deleted the at-contract-docs branch January 6, 2022 11:03
grishasobol pushed a commit to gear-tech/substrate that referenced this pull request Mar 28, 2022
…10582)

* Improve documentation of lazy deletion config

* Apply suggestions from code review

Co-authored-by: Sacha Lansky <[email protected]>

* Update frame/contracts/src/lib.rs

Co-authored-by: Andrew Jones <[email protected]>

* Improve wording

Co-authored-by: Sacha Lansky <[email protected]>
Co-authored-by: Andrew Jones <[email protected]>
ark0f pushed a commit to gear-tech/substrate that referenced this pull request Feb 27, 2023
…10582)

* Improve documentation of lazy deletion config

* Apply suggestions from code review

Co-authored-by: Sacha Lansky <[email protected]>

* Update frame/contracts/src/lib.rs

Co-authored-by: Andrew Jones <[email protected]>

* Improve wording

Co-authored-by: Sacha Lansky <[email protected]>
Co-authored-by: Andrew Jones <[email protected]>
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
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

4 participants