Add doc comments related to #383

[btrtrc.git] / torrent.go

diff --git a/torrent.go b/torrent.go
index 42f5636e8acb071c22809bb0079c5a92f391f00d..bcd80637258df5f42220064291fb4d2958150583 100644 (file)
--- a/torrent.go
+++ b/torrent.go
@@ -1395,6 +1395,8 @@ func (t *Torrent) addPeers(peers []Peer) {
        }
 }
 
+// The returned TorrentStats may require alignment in memory. See
+// https://github.com/anacrolix/torrent/issues/383.
 func (t *Torrent) Stats() TorrentStats {
        t.cl.rLock()
        defer t.cl.rUnlock()