From f9a59a552f4ff294dbd2da268f70c0954934abc2 Mon Sep 17 00:00:00 2001 From: Marius Date: Fri, 4 Mar 2016 22:25:15 +0100 Subject: [PATCH] Document New() functions --- memorylocker/memorylocker.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/memorylocker/memorylocker.go b/memorylocker/memorylocker.go index 51c4b83..71ea418 100644 --- a/memorylocker/memorylocker.go +++ b/memorylocker/memorylocker.go @@ -21,11 +21,14 @@ type MemoryLocker struct { locks map[string]bool } -// New creates a new lock memory. +// NewMemoryLocker creates a new in-memory locker. The DataStore parameter +// is only presented for back-wards compatibility and is ignored. Please +// use the New() function instead. func NewMemoryLocker(_ tusd.DataStore) *MemoryLocker { return New() } +// New creates a new in-memory locker. func New() *MemoryLocker { return &MemoryLocker{ locks: make(map[string]bool),