From 9fd7f566c5e3cdeb43a07b597a2fc3760776f865 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrei=20Tudor=20C=C4=83lin?= Date: Mon, 22 Oct 2018 02:42:52 +0200 Subject: [PATCH] don't mention sync.Locker in package documentation (*Flock).Lock and (*Flock).Unlock return errors, unlike the Lock and Unlock methods specified by sync.Locker. Therefore, don't mention sync.Locker in package-level documentation, to avoid confusion. Fixes #33. --- flock.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/flock.go b/flock.go index 5783a49..00f6785 100644 --- a/flock.go +++ b/flock.go @@ -2,7 +2,7 @@ // Use of this source code is governed by the BSD 3-Clause // license that can be found in the LICENSE file. -// Package flock implements a thread-safe sync.Locker interface for file locking. +// Package flock implements a thread-safe interface for file locking. // It also includes a non-blocking TryLock() function to allow locking // without blocking execution. //