From 0e9e2ed5a8672beed5b0c0ec538c2ecee7521c8f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tomasz=20Drwi=C4=99ga?= <tomusdrw@users.noreply.github.com>
Date: Wed, 18 Nov 2020 21:10:00 +0100
Subject: [PATCH] Add extra docs to on_initialize (#7552)
* Add some extra on_initialize docs.
* Address review comments.
---
substrate/frame/support/src/traits.rs | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/substrate/frame/support/src/traits.rs b/substrate/frame/support/src/traits.rs
index bc1700a43c3..b40ebe3dba6 100644
--- a/substrate/frame/support/src/traits.rs
+++ b/substrate/frame/support/src/traits.rs
@@ -1265,7 +1265,7 @@ pub trait ChangeMembers<AccountId: Clone + Ord> {
Self::change_members_sorted(&incoming[..], &outgoing[..], &new_members);
}
- /// Compute diff between new and old members; they **must already be sorted**.
+ /// Compute diff between new and old members; they **must already be sorted**.
///
/// Returns incoming and outgoing members.
fn compute_members_diff(
@@ -1427,6 +1427,9 @@ pub trait GetCallMetadata {
#[impl_for_tuples(30)]
pub trait OnFinalize<BlockNumber> {
/// The block is being finalized. Implement to have something happen.
+ ///
+ /// NOTE: This function is called AFTER ALL extrinsics in a block are applied,
+ /// including inherent extrinsics.
fn on_finalize(_n: BlockNumber) {}
}
@@ -1438,6 +1441,10 @@ pub trait OnInitialize<BlockNumber> {
/// The block is being initialized. Implement to have something happen.
///
/// Return the non-negotiable weight consumed in the block.
+ ///
+ /// NOTE: This function is called BEFORE ANY extrinsic in a block is applied,
+ /// including inherent extrinsics. Hence for instance, if you runtime includes
+ /// `pallet_timestamp`, the `timestamp` is not yet up to date at this point.
fn on_initialize(_n: BlockNumber) -> crate::weights::Weight { 0 }
}
@@ -1569,7 +1576,7 @@ pub mod schedule {
/// Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed
/// only if it is executed *before* the currently scheduled block. For periodic tasks,
/// this dispatch is guaranteed to succeed only before the *initial* execution; for
- /// others, use `reschedule_named`.
+ /// others, use `reschedule_named`.
///
/// Will return an error if the `address` is invalid.
fn reschedule(
--
GitLab