From: Matt Joiner <anacrolix@gmail.com>
Date: Tue, 3 May 2016 11:34:11 +0000 (+1000)
Subject: metainfo: Improve doc
X-Git-Tag: v1.0.0~753
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=e0451b0728ba0a7c0b723453a8483c96d63a98aa;p=btrtrc.git

metainfo: Improve doc
---

diff --git a/metainfo/metainfo.go b/metainfo/metainfo.go
index 03128669..ea4b2b89 100644
--- a/metainfo/metainfo.go
+++ b/metainfo/metainfo.go
@@ -183,8 +183,8 @@ func (info *Info) UpvertedFiles() []FileInfo {
 	return info.Files
 }
 
-// The info dictionary with its hash and raw bytes exposed, as these are
-// important to Bittorrent.
+// The info dictionary with its hash and raw bytes exposed, in case
+// remarshalling Info produces a different value.
 type InfoEx struct {
 	Info
 	Hash  Hash   // Only set when unmarshalling or UpdateHash.
@@ -236,7 +236,7 @@ func (mi *MetaInfo) SetDefaults() {
 	mi.Info.PieceLength = 256 * 1024
 }
 
-// Magnetize creates a Magnet from a MetaInfo
+// Magnetize creates a Magnet from a MetaInfo.
 func (mi *MetaInfo) Magnet() (m Magnet) {
 	for _, tier := range mi.AnnounceList {
 		for _, tracker := range tier {