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

Clean up pallet-contracts documentation #10438

Merged
merged 2 commits into from
Dec 7, 2021
Merged

Conversation

athei
Copy link
Member

@athei athei commented Dec 7, 2021

Update the changelog and remove COMPLEXITY.md. We no longer need to manually document the complexity of host functions because it is all covered by benchmarks now and we implicitly assume that all complexity is at most linear. Otherwise the benchmarks would report large errors since they aren't able to use linear regression to determine weight factors. The file was mainly duplication of documentation and horribly outdated.

@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. D2-notlive 💤 PR contains changes in a runtime directory that is not deployed to a chain that requires an audit. labels Dec 7, 2021
@athei athei requested review from ascjones and cmichi December 7, 2021 15:35
The documentation of all importable functions can be found
[here](https://github.com/paritytech/substrate/blob/master/frame/contracts/src/wasm/runtime.rs).
Look for the `define_env!` macro invocation.

Copy link
Contributor

@cmichi cmichi Dec 7, 2021

Choose a reason for hiding this comment

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

Hey nice! I like that you added this section!

@athei
Copy link
Member Author

athei commented Dec 7, 2021

bot merge

@paritytech-processbot paritytech-processbot bot merged commit 95853fb into master Dec 7, 2021
@paritytech-processbot paritytech-processbot bot deleted the at-changelog branch December 7, 2021 16:48
grishasobol pushed a commit to gear-tech/substrate that referenced this pull request Mar 28, 2022
* Update CHANGELOG.md

* Remove COMPLEXITY.md
ark0f pushed a commit to gear-tech/substrate that referenced this pull request Feb 27, 2023
* Update CHANGELOG.md

* Remove COMPLEXITY.md
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. D2-notlive 💤 PR contains changes in a runtime directory that is not deployed to a chain that requires an audit.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants