Skip to content

Commit 5d08024

Browse files
committed
Update README with more details
1 parent 79e604c commit 5d08024

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.rst

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,36 @@ module (see PEP 567) for Python 3.6.
1111
**Important:** at this moment this package does not provide an
1212
asyncio event loop with PEP 567 support yet. Stay tuned for updates.
1313

14-
Documentation: https://docs.python.org/3.7/library/contextvars.html
1514

16-
Usage:
15+
Documentation
16+
=============
17+
18+
Read the official ``contextvars`` module documentation here:
19+
https://docs.python.org/3.7/library/contextvars.html
20+
21+
22+
`PEP 567 <https://www.python.org/dev/peps/pep-0567/>`_ also provides
23+
a comprehensive overview of the API and explains the design choices.
24+
25+
26+
Installation
27+
============
28+
29+
.. code-block:: bash
30+
31+
$ pip install pep567
32+
33+
34+
Usage
35+
=====
1736

1837
.. code-block:: python
1938
2039
try:
40+
# Python 3.7
2141
import contextvars
2242
except ImportError:
43+
# Python <= 3.6
2344
import pep567 as contextvars
2445
2546
my_var = contextvars.ContextVar('my_var')

0 commit comments

Comments
 (0)