[Twisted-Python] Doc patch
Garth Kidd
garth at netapp.com
Sun Feb 2 13:58:32 MST 2003
Got a wee doc patch for you, based on my experimentation so far:
Index: doc/howto/defer.html
===================================================================
RCS file: /cvs/Twisted/doc/howto/defer.html,v
retrieving revision 1.29
diff -c -r1.29 defer.html
*** doc/howto/defer.html 12 Dec 2002 08:04:15 -0000 1.29
--- doc/howto/defer.html 1 Feb 2003 07:13:29 -0000
***************
*** 117,122 ****
--- 117,126 ----
reactor.run()
</pre>
+ <p>(Note that if you save this to a file and run it, <em>nothing will
+ happen</em>. There's no code to let the reactor know about the getter,
+ and no code to call <code>gotResult</code>.)</p>
+
<h3>Visual Explanation</h3>
<div hlint="off" align="center">
Index: doc/howto/plugin.html
===================================================================
RCS file: /cvs/Twisted/doc/howto/plugin.html,v
retrieving revision 1.22
diff -c -r1.22 plugin.html
*** doc/howto/plugin.html 12 Nov 2002 06:06:46 -0000 1.22
--- doc/howto/plugin.html 1 Feb 2003 07:13:33 -0000
***************
*** 364,371 ****
<a href="listings/TwistedQuotes/plugins.tml"
class="py-listing">Twisted Quotes
Plug-in registration</a>
! <p>Now the QOTD server is ready to be instantiated! Let's start up a
server
! and get a quote from it.</p>
<pre class="shell">
% mktap qotd
--- 364,386 ----
<a href="listings/TwistedQuotes/plugins.tml"
class="py-listing">Twisted Quotes
Plug-in registration</a>
! <p>You may be wondering <em>how</em> mktap finds it. The answer can be
found
! with a little digging in
<code>twisted.python.plugin.getPluginFileList</code>:
! by recursing through subdirectories of <code>sys.path</code> looking
for
! files named <code>plugins.tml</code>. So, if you put
<code>plugins.tml</code>
! in <code>TwistedQuotes/</code>, <code>mktap</code> will find it. Or,
if you
! put it in your current directory like I did the first time,
<code>mktap</code>
! will rightly complain:</p>
!
! <pre class="shell">
! $ mktap qotd
! Unknown command: qotd
! Usage: mktap [options] <command> [command options]
! ...
! </pre>
!
! <p>Assuming <code>plugins.tml</code> is in the right place, the QOTD
server
! is ready to be instantiated! Let's start up a server and get a quote
from it.</p>
<pre class="shell">
% mktap qotd
More information about the Twisted-Python
mailing list