]> granicus.if.org Git - python/commitdiff
Doc: fcntl.lockf() is more powerful than written (GH-6750)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 13 Sep 2019 17:39:42 +0000 (10:39 -0700)
committerGitHub <noreply@github.com>
Fri, 13 Sep 2019 17:39:42 +0000 (10:39 -0700)
(cherry picked from commit 77cd0ceab2f6c1696fb1d31115c2f880b2e21934)

Co-authored-by: Eric O. LEBIGOT (EOL) <lebigot@users.noreply.github.com>
Doc/library/fcntl.rst

index 2db9674952d7b66baba19c02585f0b6e63b10614..a7390150f7910d9933e1743fa7eaeffe2560661c 100644 (file)
@@ -120,7 +120,8 @@ The module defines the following functions:
 .. function:: lockf(fd, cmd, len=0, start=0, whence=0)
 
    This is essentially a wrapper around the :func:`~fcntl.fcntl` locking calls.
-   *fd* is the file descriptor of the file to lock or unlock, and *cmd*
+   *fd* is the file descriptor (file objects providing a :meth:`~io.IOBase.fileno`
+   method are accepted as well) of the file to lock or unlock, and *cmd*
    is one of the following values:
 
    * :const:`LOCK_UN` -- unlock
@@ -171,4 +172,3 @@ using the :func:`flock` call may be better.
       present in the :mod:`os` module (on BSD only), the :func:`os.open`
       function provides an alternative to the :func:`lockf` and :func:`flock`
       functions.
-