Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix Sphinx errors in Channel docs #721

Merged
merged 1 commit into from
Oct 5, 2018
Merged

docs: fix Sphinx errors in Channel docs #721

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/source/reference-core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1445,7 +1445,7 @@ than the consumers, then it forces the producers to slow down.
You can disable buffering entirely, by doing
``open_memory_channel(0)``. In that case any task calls
:meth:`~trio.abc.SendChannel.send` will wait until another task calls
`~trio.abc.SendChannel.receive`, and vice versa. This is similar to
:meth:`~trio.abc.ReceiveChannel.receive`, and vice versa. This is similar to
how channels work in the `classic Communicating Sequential Processes
model <https://en.wikipedia.org/wiki/Channel_(programming)>`__, and is
a reasonable default if you aren't sure what size buffer to use.
Expand All @@ -1455,7 +1455,7 @@ At the other extreme, you can make the buffer unbounded by using
``open_memory_channel(math.inf)``. In this case,
:meth:`~trio.abc.SendChannel.send` *always* returns immediately.
Normally, this is a bad idea. To see why, consider a program where the
producer runs more quickly than the consumer::
producer runs more quickly than the consumer:

.. literalinclude:: reference-core/channels-backpressure.py

Expand Down Expand Up @@ -1753,7 +1753,7 @@ Getting back into the trio thread from another thread

This will probably be clearer with an example. Here we demonstrate how
to spawn a child thread, and then use a :ref:`memory channel
<channels>` to send messages between the thread and a trio task::
<channels>` to send messages between the thread and a trio task:

.. literalinclude:: reference-core/blocking-trio-portal-example.py

Expand Down