[Twisted-Python] IReactorCore.iterate docstring

[Jean-Paul Calderone]

On Fri, 14 Apr 2006 16:54:49 -0200, Manlio Perillo <manlio_perillo at libero.it> wrote:
>"""Run the main loop's I/O polling function for a period of time.
>
>This is most useful in applications where the UI is being drawn "as
>fast as possible", such as games. All pending IDelayedCalls will be called.
>The reactor must have been started (via the run() method) prior to any
>invocations of this method. It must also be stopped manually after the
>last call to this method (via the stop() method). This method is not
>re-entrant: you must not call it recursively; in particular, you must
>not call it while the reactor is running."""
>
>
>I'm not sure to understand this:
>"The reactor must have been started" and
>"you must not call it while the reactor is running"
>

The docstring should actually read:

    """
    Not a public method.  Do not call this method.
    """

Jean-Paul