add some doc comments

2026-06-13 02:11:01 +00:00 · 2021-07-01 09:58:18 +01:00
parent 5d00445324
commit 4bb1f19085
4 changed files with 13 additions and 2 deletions
@@ -1,3 +1,8 @@
+//! This is the internal represenation of telemetry messages sent from nodes.
+//! There is a separate JSON representation of these types, because internally we want to be
+//! able to serialize these messages to bincode, and various serde attribtues aren't compatible
+//! with this, hence this separate internal representation.
+
 use crate::node_types::{Block, BlockHash, BlockNumber, NodeDetails};
 use serde::{Deserialize, Serialize};