Skip to content
This repository was archived by the owner on May 31, 2021. It is now read-only.

Commit 0fdea2b

Browse files
mentaalludovic-gasc
authored andcommitted
some grammatical and typo fixes (#3)
* small tweaks to documentation, typos, grammar etc * fixed semantic error in hello_word.rst docs
1 parent da1be48 commit 0fdea2b

File tree

4 files changed

+14
-8
lines changed

4 files changed

+14
-8
lines changed

getting_started.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ Getting Started
55
Get Python 3.5
66
==============
77

8-
Sorry but this documentation is written for Python 3.5 to get the new ``async``
8+
Sorry but this documentation is written for Python 3.5 to avail of the new ``async``
99
and ``await`` keywords.
1010

11+
.. would be good to have some word about installing on Windows
12+
* Windows: the easiest way to use Python 3.5 would be to use a package manager like Conda
13+
There are instructions for using a python 3.5 environment in `Conda here <http://conda.pydata.org/docs/py2or3.html#create-a-python-3-5-environment>`_.
1114
* Mac OS X: install `Homebrew </usr/bin/ruby -e "$(curl -fsSL
1215
https://raw.githubusercontent.com/Homebrew/install/master/install)">`_ and
1316
then type ``brew install python3``
@@ -22,6 +25,9 @@ Create a virtual environment::
2225

2326
python3 -m venv venv
2427

28+
.. note::
29+
Depending on your platform, the python 3 interpreter could be invoked by ``python`` instead. This is the case for Conda on Windows for example.
30+
2531
Install aiohttp in the virtual environment::
2632

2733
venv/bin/python -m pip install -U aiohttp

glossary.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Glossary
99
.. glossary::
1010

1111
coroutine
12-
It's a piece of code that can be paused and resumed. Whereas threads are preemptively multitasked by the operating system, coroutines multitask cooperatively: they choose when to pause, and which coroutine to run next.
12+
A coroutine is a piece of code that can be paused and resumed. In contrast to threads which are preemptively multitasked by the operating system, coroutines multitask cooperatively. I.e. they choose when to pause (or to use terminology for coroutines before 3.4 - ``yield``) execution. They can also execute other coroutines.
1313

1414
event loop
1515
The event loop is the central execution device to launch execution of coroutines and handle I/O (Network, sub-processes...)
@@ -18,4 +18,4 @@ Glossary
1818
It's like a mailbox where you can subscribe to receive a result when it will be done. More details in `official documentation <https://docs.python.org/3/library/asyncio-task.html#future>`_
1919

2020
task
21-
It represents the execution of a coroutine and take care the result in a future. More details in `official documentation <https://docs.python.org/3/library/asyncio-task.html#task>`_
21+
It represents the execution of a coroutine and take care the result in a future. More details in `official documentation <https://docs.python.org/3/library/asyncio-task.html#task>`_

hello_world.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ schedule them in the asyncio :term:`event loop <event loop>`.
88
Simple coroutine
99
----------------
1010

11-
Example using the :meth:`BaseEventLoop.run_until_complete` method to schedule
11+
Example using the :meth:`BaseEventLoop.run_until_complete` method to schedule a
1212
simple function that will wait one second, print 'hello' and then finish.
1313

1414
Because it is launched with `run_until_complete`, the :term:`event loop <event loop>` itself
15-
with terminate once the :term:`coroutine <coroutine>` is completed.
15+
will terminate once the :term:`coroutine <coroutine>` is completed.
1616

1717
.. literalinclude:: examples/hello_world.py
1818

@@ -24,7 +24,7 @@ This second example show how you can schedule multiple :term:`coroutines <corout
2424
event loop, and then run the :term:`event loop <event loop>`.
2525

2626
Notice that this example will print 'second_hello' before 'first_hello',
27-
as the second :term:`task <task>` scheduled waits longer that the first one before printing.
27+
as the first :term:`task <task>` scheduled waits longer that the second one before printing.
2828

2929
Also note that this example will never terminate, as the :term:`loop <event loop>` is asked to
3030
`run_forever`.

index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Asyncio Documentation
33
+++++++++++++++++++++
44

5-
Chapiter 1: First steps with asyncio
5+
Chapter 1: First steps with asyncio
66
====================================
77

88
.. toctree::
@@ -16,7 +16,7 @@ Chapiter 1: First steps with asyncio
1616
getting_help.rst
1717

1818

19-
Chapiter 2: Advanced topics
19+
Chapter 2: Advanced topics
2020
===========================
2121

2222
.. toctree::

0 commit comments

Comments
 (0)