Re: [Async-sig] async documentation methods

2017-07-06 Thread Andrew Svetlov
I think the code itself is not beg deal (I could commit on the task if needed) but we need an agreement about markup and output formatting. On Tue, Jul 4, 2017 at 7:48 PM Brett Cannon wrote: > If no one is willing to take the time to send them a PR then the situation > is simply not going to cha

Re: [Async-sig] async documentation methods

2017-07-04 Thread Brett Cannon
If no one is willing to take the time to send them a PR then the situation is simply not going to change until the project maintainers have both the time and inclination to add async/await markup support to Sphinx, and if they personally aren't doing any async coding then that won't change anytime

Re: [Async-sig] async documentation methods

2017-07-04 Thread Andrew Svetlov
I'm an author of this code but I can confirm -- usage experience is terrible. Mostly because the loop don't advance virtual time only but tries to control every loop sleep. On Tue, Jul 4, 2017 at 5:50 PM Dima Tisnek wrote: > That's good start, looks like it would satisfy asyncio-only code :) > >

Re: [Async-sig] async documentation methods

2017-07-04 Thread Dima Tisnek
That's good start, looks like it would satisfy asyncio-only code :) I haven't noticed that earlier. On 4 July 2017 at 16:40, Andrew Svetlov wrote: > Did you look on > https://github.com/python/cpython/blob/master/Lib/asyncio/test_utils.py#L265 > ? > > On Tue, Jul 4, 2017 at 1:04 PM Dima Tisnek

Re: [Async-sig] async documentation methods

2017-07-04 Thread Andrew Svetlov
Did you look on https://github.com/python/cpython/blob/master/Lib/asyncio/test_utils.py#L265 ? On Tue, Jul 4, 2017 at 1:04 PM Dima Tisnek wrote: > Come to think of it, what sane tests need is a custom event loop or clever > mocks around asyncio.sleep, asyncio.Condition.wait, etc. So that code u

Re: [Async-sig] async documentation methods

2017-07-04 Thread Dima Tisnek
Come to think of it, what sane tests need is a custom event loop or clever mocks around asyncio.sleep, asyncio.Condition.wait, etc. So that code under test never sleeps. In simple cases actual delay in the event loop would raise an exception. A full solution would synchronise asyncio.sleep and fr

Re: [Async-sig] async documentation methods

2017-07-04 Thread Alex Grönholm
I'm somewhat reluctant to send them any PRs anymore since I sent them a couple of one liner fixes (with tests) which took around 5 months to get merged in spite of me repeatedly reminding them on the Google group. Nathaniel Smith kirjoitti 04.07.2017 klo 10:55: On Mon, Jul 3, 2017 at 11:49 PM

Re: [Async-sig] async documentation methods

2017-07-04 Thread Nathaniel Smith
On Mon, Jul 3, 2017 at 11:49 PM, Alex Grönholm wrote: > The real question is: why doesn't vanilla Sphinx have any kind of support > for async functions which have been part of the language for quite a while? Because no-one's sent them a PR, I assume. They're pretty swamped AFAICT. One of the mai

Re: [Async-sig] async documentation methods

2017-07-04 Thread Alex Grönholm
Yeah, but that doesn't answer my question :) Chris Jerdonek kirjoitti 04.07.2017 klo 10:02: On Mon, Jul 3, 2017 at 11:49 PM, Alex Grönholm wrote: The real question is: why doesn't vanilla Sphinx have any kind of support for async functions which have been part of the language for quite a whil

Re: [Async-sig] async documentation methods

2017-07-04 Thread Chris Jerdonek
On Mon, Jul 3, 2017 at 11:49 PM, Alex Grönholm wrote: > The real question is: why doesn't vanilla Sphinx have any kind of support > for async functions which have been part of the language for quite a while? It looks like this is the issue (which Brett filed in Nov. 2015): https://github.com/sphi

Re: [Async-sig] async documentation methods

2017-07-03 Thread Alex Grönholm
The real question is: why doesn't vanilla Sphinx have any kind of support for async functions which have been part of the language for quite a while? Nathaniel Smith kirjoitti 01.07.2017 klo 13:35: If we're citing curio and sphinxcontrib-asyncio I guess I'll also mention sphinxcontrib-trio [1

Re: [Async-sig] async documentation methods

2017-07-01 Thread Nathaniel Smith
If we're citing curio and sphinxcontrib-asyncio I guess I'll also mention sphinxcontrib-trio [1], which was inspired by both of them (and isn't in any way specific to trio). I don't know if the python docs can use third-party sphinx extensions, though, and it is a bit opinionated (in particular it

Re: [Async-sig] async documentation methods

2017-06-30 Thread Yury Selivanov
Hi Dima, Have you seen https://github.com/asyncio-docs?  I'm trying to get some work going there to improve asyncio docs in 3.7. Will start committing more of my time there soon. Thanks, Yury On Jun 30, 2017, 6:11 AM -0400, Dima Tisnek , wrote: > Hi all, > > I'm working to improve async docs,

Re: [Async-sig] async documentation methods

2017-06-30 Thread Brett Cannon
Curio uses `.. asyncfunction:: acquire` and it renders as `await acquire()` at least in the function definition. On Fri, 30 Jun 2017 at 03:36 Andrew Svetlov wrote: > I like "two methods, `async acquire()` and `release()`" > > Regarding to extra markups -- I created sphinxcontrib-asyncio [1] libr

Re: [Async-sig] async documentation methods

2017-06-30 Thread Andrew Svetlov
I like "two methods, `async acquire()` and `release()`" Regarding to extra markups -- I created sphinxcontrib-asyncio [1] library for it. Hmm, README is pretty empty but we do use the library for documenting aio-libs and aiohttp [2] itself We use ".. comethod:: connect(request)" for method and "c

[Async-sig] async documentation methods

2017-06-30 Thread Dima Tisnek
Hi all, I'm working to improve async docs, and I wonder if/how async methods ought to be marked in the documentation, for example library/async-sync.rst: """ ... It [lock] has two basic methods, `acquire()` and `release()`. ... """ In fact, these methods are not symmetric, the earlier is asynchr