t.i.task.react's docstring doesn't mention the reactor argument

[habnabit]

The docstring for t.i.task.react says:

    @param main: A callable which returns a L{Deferred}.  It should take as
        many arguments as there are elements in the list C{argv}.

But main is called as: finished = main(_reactor, *argv)

The docstring should be updated to reflect that main will be called with the reactor as an argument.

[reecer]

Changed the docstring to the following:

    @param main: A callable which returns a L{Deferred}.  It should take as
        many arguments as there are elements in the list C{argv}. Called with 
        _reactor as first parameter.

[reecer]

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

[itamar]

Thanks for the patch! Make sure you add the "review" keyword when submitting a patch to Twisted, so we know to look at it.

[tomprince]

(In [38461]) Branching to react-reactor-arg-6071.

[tomprince]

(In [38462]) Apply task_docstring.patch from reecer.

Refs: #6071.

[tom.prince]

Thanks for your contribution, and sorry for the delay in responding to it.

Your change is an improvement on the current decription, but it still isn't entirely clear how main gets called. It should perhaps say something about taking reactor, followed by the elemnts of argv.

One thing that the current wording doesn't make clear, is that main can have optional and *args as well.

(Please submit further patches against the code in the branch)