more docstring

2022-09-21 19:29:40 -06:00 · 2022-09-21 19:29:40 -06:00 · 0a09d23525
parent e111694b3e
commit 0a09d23525
1 changed files with 2 additions and 1 deletions
--- a/src/allmydata/util/pid.py
+++ b/src/allmydata/util/pid.py
@ -105,7 +105,8 @@ def check_pid_process(pidfile):

 def cleanup_pidfile(pidfile):
    """
-    Safely clean up a PID-file
+    Remove the pidfile specified (respecting locks). If anything at
+    all goes wrong, `CannotRemovePidFile` is raised.
    """
    lock_path = _pidfile_to_lockpath(pidfile)
    with FileLock(lock_path.path):