Tidy up doc, file names, naming

[btrtrc.git] / piece.go

diff --git a/piece.go b/piece.go
index 56dedec6d044c954fcf7364908e8bef9dfc1a8bb..08fc9bab0dfc93706e48a1389ee819fa8bd094de 100644 (file)
--- a/piece.go
+++ b/piece.go
@@ -240,6 +240,8 @@ func (p *Piece) uncachedPriority() (ret piecePriority) {
        return
 }
 
+// Tells the Client to refetch the completion status from storage, updating priority etc. if
+// necessary. Might be useful if you know the state of the piece data has changed externally.
 func (p *Piece) UpdateCompletion() {
        p.t.cl.lock()
        defer p.t.cl.unlock()