summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSkip Montanaro <skip@pobox.com>2004-09-03 00:04:05 (GMT)
committerSkip Montanaro <skip@pobox.com>2004-09-03 00:04:05 (GMT)
commit0bbf137fbd53ba1354015a0f72ba7cc96a3c8975 (patch)
tree96d24865a1379ff7712dff39f4cde64765c92aed
parent15f611845b15ce8787e0b2399f2ecd686fe46f52 (diff)
downloadcpython-0bbf137fbd53ba1354015a0f72ba7cc96a3c8975.zip
cpython-0bbf137fbd53ba1354015a0f72ba7cc96a3c8975.tar.gz
cpython-0bbf137fbd53ba1354015a0f72ba7cc96a3c8975.tar.bz2
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.
-rw-r--r--Doc/lib/libsimplexmlrpc.tex9
1 files changed, 7 insertions, 2 deletions
diff --git a/Doc/lib/libsimplexmlrpc.tex b/Doc/lib/libsimplexmlrpc.tex
index 44d14f5..dd486d9 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