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

Update Scheduler Pallet Documentation #14740

Merged
merged 13 commits into from
Aug 15, 2023
Merged

Update Scheduler Pallet Documentation #14740

merged 13 commits into from
Aug 15, 2023

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
kilogold
kilogold reviewed Aug 12, 2023
View reviewed changes
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.

frame/scheduler/Cargo.toml Outdated Show resolved Hide resolved
frame/scheduler/src/lib.rs Outdated Show resolved Hide resolved
@snowmead @kilogold
Update call filter note
1613d41 
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.

@snowmead snowmead force-pushed the snowmead-scheduler-pallet-security-doc branch from d89af6c to eb5e32f Compare August 12, 2023 16:35
@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
@snowmead @KiChjang
Doc wording
d0afed4 
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
@snowmead @KiChjang
Doc wording
a754cf0 
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
kianenigma
kianenigma reviewed Aug 14, 2023
View reviewed changes
frame/scheduler/src/lib.rs Outdated Show resolved Hide resolved
frame/scheduler/src/lib.rs Outdated Show resolved Hide resolved
@paritytech-ci paritytech-ci requested a review from a team August 14, 2023 03:20
kianenigma
kianenigma approved these changes Aug 14, 2023
View reviewed changes
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!

@snowmead
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
4b47c09 
Ammend comments related to documentation
@snowmead snowmead force-pushed the snowmead-scheduler-pallet-security-doc branch from 1c3c28f to 4b47c09 Compare August 14, 2023 13:48
@snowmead snowmead force-pushed the snowmead-scheduler-pallet-security-doc branch from 488cc10 to 71be207 Compare August 14, 2023 14:30
sam0x17
sam0x17 approved these changes Aug 14, 2023
View reviewed changes
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

frame/scheduler/src/lib.rs Outdated Show resolved Hide resolved
frame/scheduler/src/lib.rs Outdated Show resolved Hide resolved
muharem
muharem reviewed Aug 14, 2023
View reviewed changes
frame/scheduler/src/lib.rs Outdated Show resolved Hide resolved
snowmead and others added 3 commits August 14, 2023 13:49
@snowmead @sam0x17
Amend doc
dd276bd 
Co-authored-by: Sam Johnson <sam@durosoft.com>
@snowmead @sam0x17
Amend doc
163bdcf 
Co-authored-by: Sam Johnson <sam@durosoft.com>
@snowmead
Move no_std to appropriate place
9cee4d3
naterarmstrong
naterarmstrong approved these changes Aug 14, 2023
View reviewed changes
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.

❤️

frame/scheduler/src/tests.rs Outdated Show resolved Hide resolved
frame/scheduler/src/tests.rs Outdated Show resolved Hide resolved
snowmead and others added 2 commits August 14, 2023 19:37
@snowmead @naterarmstrong
Amend doc
070b2ff 
Co-authored-by: Nate Armstrong <naterarmstrong@gmail.com>
@snowmead @naterarmstrong
Amend comment
6dbaac2 
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
8 checks passed
Ank4n pushed a commit that referenced this pull request Aug 20, 2023
@snowmead @kilogold
@KiChjang @sam0x17 @naterarmstrong @Ank4n
Update Scheduler Pallet Documentation (#14740)
de0528b 
* 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>
@crystalin crystalin mentioned this pull request Oct 20, 2023
Closed
@JesseAbram JesseAbram mentioned this pull request Oct 26, 2023
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kilogold kilogold kilogold left review comments

@muharem muharem muharem left review comments

@gilescope gilescope gilescope approved these changes

@sam0x17 sam0x17 sam0x17 approved these changes

@KiChjang KiChjang KiChjang approved these changes

@kianenigma kianenigma kianenigma approved these changes

@wentelteefje wentelteefje wentelteefje approved these changes

@naterarmstrong naterarmstrong naterarmstrong approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document safety constraints of pallet-scheduler
9 participants
@snowmead @muharem @gilescope @kilogold @sam0x17 @KiChjang @kianenigma @wentelteefje @naterarmstrong