write Time documentation

paritytech · Jan 17, 2020 · 8f973d2 · 8f973d2
1 parent d4fbb89
commit 8f973d2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/frame/support/src/traits.rs b/frame/support/src/traits.rs
@@ -653,9 +653,14 @@ bitmask! {
 	}
 }
 
+/// A trait to query the time of the current block.
 pub trait Time {
+	/// Type used for expressing timestamp.
 	type Moment: SimpleArithmetic + Parameter + Default + Copy;
 
+	/// Return the last timestamp set by inherent. If called before the inherent providing
+	/// timestamp for the current block (i.e. in-between blocks, in on_initialize, or in previous
+	/// inherents) then the moment of the previous block is returned or 0 for the first block.
 	fn now() -> Self::Moment;
 }
 

diff --git a/frame/timestamp/src/lib.rs b/frame/timestamp/src/lib.rs
@@ -230,7 +230,6 @@ impl<T: Trait> ProvideInherent for Module<T> {
 impl<T: Trait> Time for Module<T> {
 	type Moment = T::Moment;
 
-	/// Before the first set of now with inherent the value returned is zero.
 	fn now() -> Self::Moment {
 		Self::now()
 	}