Skip to content

Commit

Permalink
don't mention sync.Locker in package documentation
Browse files Browse the repository at this point in the history
(*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.
  • Loading branch information
acln0 committed Oct 22, 2018
1 parent 7f43ea2 commit 9fd7f56
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion flock.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
//
Expand Down

0 comments on commit 9fd7f56

Please sign in to comment.