From: Skip Montanaro <skip@pobox.com>
Date: Fri, 3 Sep 2004 00:04:05 +0000 (+0000)
Subject: Make the api of the _dispatch() method more concrete.  I have no idea if
X-Git-Tag: v2.4b1~352
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0bbf137fbd53ba1354015a0f72ba7cc96a3c8975;p=python

Make the api of the _dispatch() method more concrete.  I have no idea if
this is the right way to document such things (Fred, help me out here :-),
but I got misled by the existing documentation and assumed the parameter
list was a *args sort of thing.
---

diff --git a/Doc/lib/libsimplexmlrpc.tex b/Doc/lib/libsimplexmlrpc.tex
index 44d14f5847..dd486d9cc5 100644
--- a/Doc/lib/libsimplexmlrpc.tex
+++ b/Doc/lib/libsimplexmlrpc.tex
@@ -59,8 +59,13 @@ simple, stand alone XML-RPC servers.
   Register an object which is used to expose method names which have
   not been registered using \method{register_function()}.  If
   \var{instance} contains a \method{_dispatch()} method, it is called
-  with the requested method name and the parameters from the request;
-  the return value is returned to the client as the result.  If
+  with the requested method name and the parameters from the request.  Its
+  API is \code{def \method{_dispatch}(self, method, params)} (note tha
+  \var{params} does not represent a variable argument list).  If it calls an
+  underlying function to perform its task, that function is called as
+  \code{func(*params)}, expanding the parameter list.
+  The return value from \method{_dispatch()} is returned to the client as
+  the result.  If
   \var{instance} does not have a \method{_dispatch()} method, it is
   searched for an attribute matching the name of the requested method;
   if the requested method name contains periods, each component of the