Add examples

[Gr1N]

Hi,

I don't know what about this task, but I want to help and improve existing docstrings, because:

• some of them with mistakes, e.g.: every.py and repeat.py;
• they are written in many styles, e.g.: some of them with execution results, some not;
• and most of examples you can't just copy and run.

Below you can find my ideas about how to improve current examples.

1. python repl + paco.run

   
   diff --git a/paco/partial.py b/paco/partial.py
   index 341cf49..c76ea47 100755
   --- a/paco/partial.py
   +++ b/paco/partial.py
   @@ -24,8 +24,14 @@ def partial(coro, *args, **kw):
   
    Usage::

• task = paco.partial(coro, 1, foo='bar')
• await task(2, bar='foo')

• async def pow(x, y):

• ... return x ** y
• ...

• pow_2 = paco.partial(pow, 2)

• paco.run(pow_2(4))

• 16

  """ assert_corofunction(coro=coro)

2. ipython repl + paco.run

   
   diff --git a/paco/partial.py b/paco/partial.py
   index 341cf49..24296c4 100755
   --- a/paco/partial.py
   +++ b/paco/partial.py
   @@ -24,8 +24,14 @@ def partial(coro, *args, **kw):
   
    Usage::

• task = paco.partial(coro, 1, foo='bar')
• await task(2, bar='foo')
• In [1]: async def pow(x, y):
• ...: return x ** y
• ...:
• In [2]: pow_2 = paco.partial(pow, 2)
• In [3]: paco.run(pow_2(4))

• Out[3]: 16

  """ assert_corofunction(coro=coro)

3. just code with await syntax

   
   diff --git a/paco/partial.py b/paco/partial.py
   index 341cf49..444f031 100755
   --- a/paco/partial.py
   +++ b/paco/partial.py
   @@ -24,8 +24,15 @@ def partial(coro, *args, **kw):
   
    Usage::

• task = paco.partial(coro, 1, foo='bar')
• await task(2, bar='foo')
• async def pow(x, y):
• return x ** y
• pow_2 = paco.partial(pow, 2)
• await pow_2(4)

• 16

• """ assert_corofunction(coro=coro)

@h2non what do you think? Any ideas?

[h2non]

I like doctest style (the first one), but I found more versatile the last one, so I would bet for last one.

I'm very open to introduce any enhancements in this sense that leverages overall library quality and makes it more easy to consume.

Any PR would be appreciated.

[h2non]

I think we are fine in terms of example code for now. Closing issue.