Skip to content

Commit 86d8fbb

Browse files
committed
Update documentation and bump
1 parent bc87de9 commit 86d8fbb

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

README.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ This package also includes helpers:
4646

4747
* `PrettyFormat`
4848

49+
* `async_logwrap` *on python 3.5+ only*
50+
4951
Usage
5052
=====
5153

@@ -145,10 +147,15 @@ This code during execution will produce log records:
145147
))
146148

147149
Limitations:
148-
* return value from awaitable objects (`async def(...`) is not accessible - on call asyncio object is returned.
150+
* return value from awaitable objects (`async def(...`) is not accessible - on call asyncio object is returned. Please use `async_logwrap` instead.
149151

150152
* nested wrapping (`@logwrap @deco2 ...`) is not parsed under python 2.7: `funcsigs` limitation. Please set `logwrap` as the first level decorator.
151153

154+
async_logwrap
155+
-------------
156+
Async version of `logwrap` decorator. Usage is the same as `logwrap`, but result object type is coroutine.
157+
**This method is available only on python 3.5+ installations.**
158+
152159
pretty_repr
153160
-----------
154161
This is specified helper for making human-readable repr on complex objects.

logwrap/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
from ._repr_utils import pretty_repr
3232
from ._repr_utils import pretty_str
3333

34-
__version__ = '1.3.0'
34+
__version__ = '2.0.0'
3535

3636
__all__ = (
3737
'logwrap',

0 commit comments

Comments
 (0)