Added comment for WireMessage.Marshal

linux4life798 · Oct 2, 2018 · 49ee38f · 49ee38f
1 parent 752cf3a
commit 49ee38f
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/wiremessage.go b/wiremessage.go
@@ -626,6 +626,7 @@ func (fs fieldNumArray) Len() int           { return len(fs) }
 func (fs fieldNumArray) Swap(i, j int)      { fs[i], fs[j] = fs[j], fs[i] }
 func (fs fieldNumArray) Less(i, j int) bool { return fs[i] < fs[j] }
 
+// Marshal generates the byte stream for a given WireMessage
 func (m *WireMessage) Marshal() ([]byte, error) {
 	fields := fieldNumArray(m.GetFieldNums())
 	sort.Sort(fields) // protobuf encoding should be in increaing key order