From: Fredrik Tolf <fredrik@dolda2000.com>
Date: Fri, 23 Dec 2011 01:01:27 +0000 (+0100)
Subject: Improved documentation.
X-Git-Tag: 0.1~1^2~2
X-Git-Url: http://git.dolda2000.com/gitweb/?a=commitdiff_plain;h=ebd7a8ba1cfa6feee987b7d7ac69f50a2e0a345e;p=pdm.git

Improved documentation.
---

diff --git a/pdm/cli.py b/pdm/cli.py
index 81246b7..46276be 100644
--- a/pdm/cli.py
+++ b/pdm/cli.py
@@ -1,7 +1,9 @@
-"""Management for daemon processes
+"""Python Daemon Management -- Client functions
 
-This module provides some client support for the daemon management
-provided in the pdm.srv module.
+This module implements the client part of the PDM protocols. The
+primary objects of interest are the replclient and perfclient classes,
+which implement support for their respective protocols. See their
+documentation for details.
 """
 
 import socket, pickle, struct, select, threading
@@ -313,6 +315,11 @@ class perfclient(client):
         of the slash. For instance, find("pdm.perf.sysres/cputime")
         will return the built-in attribute for reading the CPU time
         used by the server process.
+
+        The proxy objects returned by this function are cached and the
+        same object are returned the next time the same name is
+        requested, which means that they are kept live until the
+        client connection is closed.
         """
         ret = self.names.get(name)
         if ret is None: