I like to have simple markup for coroutines but -1 for using return annotation for that. Return annotation is for return value description, not for function itself.
On Thu, Feb 12, 2015 at 6:06 PM, Victor Stinner <[email protected]> wrote: > Hi, > > 2015-02-12 12:51 GMT+01:00 Luciano Ramalho <[email protected]>: >> This is more visible than a sentence like "This method is a >> coroutine." buried somewhere in its description. > > We should keep this sentence *and* add the return type in the doc. > > I tried to add " -> coroutine": > > .. method:: BaseEventLoop.create_connection(...) -> coroutine > > It works in Sphinx. But I don't know if it is the chosen syntax to > indicate the return type. > >> The notation "-> {{coroutine}}" is just a stand-in for now. > > I don't understand "{{". It looks like a set of set. I prefer just "-> > coroutine". > > Victor -- Thanks, Andrew Svetlov
