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.

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

Channels, a replacement for Queues #586

Merged
merged 23 commits into from
Oct 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 2 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,7 @@
("py:class", "trio.hazmat.RunLocal"),
# trio.abc is documented at random places scattered throughout the docs
("py:mod", "trio.abc"),
# contextvars is added in 3.7, but the docs point to 3.6
# these two entries can be removed after 3.7 is released
("py:mod", "contextvars"),
("py:class", "contextvars.Context"),
("py:class", "math.inf"),
]
autodoc_inherit_docstrings = False

Expand Down Expand Up @@ -70,7 +67,7 @@ def setup(app):

intersphinx_mapping = {
"python": ('https://docs.python.org/3', None),
"outcome": ('https://outcome.readthedocs.org/en/latest/', None),
"outcome": ('https://outcome.readthedocs.io/en/latest/', None),
}

autodoc_member_order = "bysource"
Expand Down
7 changes: 1 addition & 6 deletions docs/source/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -413,11 +413,6 @@ Specific style guidelines

and the ``nowait`` version raises :exc:`trio.WouldBlock` if it would block.

* The word ``monitor`` is used for APIs that involve an
:class:`trio.hazmat.UnboundedQueue` receiving some kind of events.
(Examples: nursery ``.monitor`` attribute, some of the low-level I/O
functions in :mod:`trio.hazmat`.)

* ...we should, but currently don't, have a solid convention to
distinguish between functions that take an async callable and those
that take a sync callable. See `issue #68
Expand Down Expand Up @@ -447,7 +442,7 @@ strategy is to make sure that it's possible for independent packages
to add new features on top of trio. Enforcing the ``trio`` vs
``trio._core`` split is a way of `eating our own dogfood
<https://en.wikipedia.org/wiki/Eating_your_own_dog_food>`__: basic
functionality like :class:`trio.Queue` and :mod:`trio.socket` is
functionality like :class:`trio.Lock` and :mod:`trio.socket` is
actually implemented solely in terms of public APIs. And the hope is
that by doing this, we increase the chances that someone who comes up
with a better kind of queue or wants to add some new functionality
Expand Down
6 changes: 3 additions & 3 deletions docs/source/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Features
the creator's :mod:`contextvars` context, instead using one created at
:func:`~trio.run`. (`#289
<https://github.com/python-trio/trio/issues/289>`__)
- Add support for :class:`trio.Queue` with `capacity=0`. Queue's implementation
- Add support for ``trio.Queue`` with ``capacity=0``. Queue's implementation
is also faster now. (`#473
<https://github.com/python-trio/trio/issues/473>`__)
- Switch to using standalone `Outcome
Expand Down Expand Up @@ -397,7 +397,7 @@ Upcoming breaking changes with warnings (i.e., stuff that in 0.2.0
See `#68 <https://github.com/python-trio/trio/issues/68>`__ for
details.

* :class:`trio.Queue`\'s ``join`` and ``task_done`` methods are
* ``trio.Queue``\'s ``join`` and ``task_done`` methods are
deprecated without replacement (`#321
<https://github.com/python-trio/trio/issues/321>`__)

Expand All @@ -424,7 +424,7 @@ Upcoming breaking changes with warnings (i.e., stuff that in 0.2.0
* ``trio.Result`` → ``trio.hazmat.Result``
* ``trio.Value`` → ``trio.hazmat.Value``
* ``trio.Error`` → ``trio.hazmat.Error``
* ``trio.UnboundedQueue`` → :class:`trio.hazmat.UnboundedQueue`
* ``trio.UnboundedQueue`` → ``trio.hazmat.UnboundedQueue``

In addition, several introspection attributes are being renamed:

Expand Down
Loading