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

Update Scheduler Pallet Documentation#14740

Merged
paritytech-processbot[bot] merged 13 commits intoparitytech:masterfrom
snowmead:snowmead-scheduler-pallet-security-doc
Aug 15, 2023
Merged

Update Scheduler Pallet Documentation#14740
paritytech-processbot[bot] merged 13 commits intoparitytech:masterfrom
snowmead:snowmead-scheduler-pallet-security-doc

Conversation

@snowmead
Copy link
Contributor

@snowmead snowmead commented Aug 9, 2023

Description

Updates the documentation of the Scheduler Pallet based on pallet documentation guidelines.

Warning section added to inform users of some anti-patterns when scheduling runtime calls due to misconceptions of the pallet.

Closes #14715

@snowmead snowmead requested review from a team August 9, 2023 20:05
@cla-bot-2021
Copy link

cla-bot-2021 bot commented Aug 9, 2023

User @snowmead, please sign the CLA here.

@snowmead snowmead marked this pull request as draft August 9, 2023 20:12
@muharem
Copy link
Contributor

muharem commented Aug 10, 2023

there is a new documentation guidelines you might wanna check https://github.com/paritytech/substrate/blob/master/docs/DOCUMENTATION_GUIDELINES.md

@kianenigma kianenigma marked this pull request as ready for review August 12, 2023 04:17
Copy link
Contributor

@kilogold kilogold left a comment

Choose a reason for hiding this comment

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

I like what I'm seeing here.

Co-authored-by: Kelvin Bonilla <bonilla_kelvin@hotmail.com>
@cla-bot-2021
Copy link

cla-bot-2021 bot commented Aug 12, 2023

User @kilogold, please sign the CLA here.

@paritytech-ci paritytech-ci requested a review from a team August 12, 2023 19:18
@paritytech-ci paritytech-ci requested a review from a team August 12, 2023 19:18
snowmead and others added 2 commits August 12, 2023 16:05
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
@kianenigma kianenigma added A0-please_review Pull request needs code review. 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. B1-note_worthy Changes should be noted in the release notes T1-runtime This PR/Issue is related to the topic “runtime”. labels Aug 14, 2023
@paritytech-ci paritytech-ci requested a review from a team August 14, 2023 03:15
@paritytech-ci paritytech-ci requested a review from a team August 14, 2023 03:18
@paritytech-ci paritytech-ci requested a review from a team August 14, 2023 03:18
@paritytech-ci paritytech-ci requested a review from a team August 14, 2023 03:20
Copy link
Contributor

@kianenigma kianenigma left a comment

Choose a reason for hiding this comment

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

Some suggestions, but all in all looks good!

Copy link
Contributor

@sam0x17 sam0x17 left a comment

Choose a reason for hiding this comment

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

few grammar / wording nits, then looks good

snowmead and others added 3 commits August 14, 2023 13:49
Co-authored-by: Sam Johnson <sam@durosoft.com>
Co-authored-by: Sam Johnson <sam@durosoft.com>
Copy link
Contributor

@naterarmstrong naterarmstrong left a comment

Choose a reason for hiding this comment

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

❤️

snowmead and others added 2 commits August 14, 2023 19:37
Co-authored-by: Nate Armstrong <naterarmstrong@gmail.com>
Co-authored-by: Nate Armstrong <naterarmstrong@gmail.com>
@wentelteefje wentelteefje requested a review from a team August 15, 2023 10:40
@gilescope
Copy link
Contributor

bot merge

@paritytech-processbot paritytech-processbot bot merged commit c5c502c into paritytech:master Aug 15, 2023
Ank4n pushed a commit that referenced this pull request Aug 20, 2023
* Update pallet scheduler documentation, warning section, guidelines update

* Update call filter note

Co-authored-by: Kelvin Bonilla <bonilla_kelvin@hotmail.com>

* revert format cargo

* Doc wording

Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>

* Doc wording

Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>

* Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>

Ammend comments related to documentation

* Include additional warning section in `on_initialize` hook

* Amend doc

Co-authored-by: Sam Johnson <sam@durosoft.com>

* Amend doc

Co-authored-by: Sam Johnson <sam@durosoft.com>

* Move no_std to appropriate place

* Amend doc

Co-authored-by: Nate Armstrong <naterarmstrong@gmail.com>

* Amend comment

Co-authored-by: Nate Armstrong <naterarmstrong@gmail.com>

---------

Co-authored-by: Kelvin Bonilla <bonilla_kelvin@hotmail.com>
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
Co-authored-by: Sam Johnson <sam@durosoft.com>
Co-authored-by: Nate Armstrong <naterarmstrong@gmail.com>
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. B1-note_worthy Changes should be noted in the 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. T1-runtime This PR/Issue is related to the topic “runtime”.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document safety constraints of pallet-scheduler

9 participants