Ticket #6071: task_docstring.patch

File task_docstring.patch, 742 bytes (added by reecer, 9 years ago)

Updated the docstring for the PARAM "main" to include that the PARAM _reactor is the first argument when calling "main."

  • twisted/internet/task.py

    diff --git task_docstring.patch task_docstring.patch
    new file mode 100644
    index 0000000..e69de29
    diff --git twisted/internet/task.py twisted/internet/task.py
    index 5d8ff4b..d5fa5ad 100644
    def react(main, argv=(), _reactor=None): 
    815815        code returned is used.
    816816
    817817    @param main: A callable which returns a L{Deferred}.  It should take as
    818         many arguments as there are elements in the list C{argv}.
     818        many arguments as there are elements in the list C{argv}. Called with
     819        _reactor as first parameter.
    819820
    820821    @param argv: A list of arguments to pass to C{main}. If omitted the
    821822        callable will be invoked with no additional arguments.