Document the Time::from_utc helper

informalsystems · Dec 7, 2021 · f5e6244 · f5e6244
1 parent d87e926
commit f5e6244
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/tendermint/src/time.rs b/tendermint/src/time.rs
@@ -64,6 +64,9 @@ impl From<Time> for Timestamp {
 }
 
 impl Time {
+    // Internal helper to produce a `Time` value validated with regard to
+    // the date range allowed in protobuf timestamps.
+    // The source `OffsetDateTime` value must have the zero UTC offset.
     fn from_utc(t: OffsetDateTime) -> Result<Self, Error> {
         debug_assert_eq!(t.offset(), offset!(UTC));
         match t.year() {