]> granicus.if.org Git - python/commitdiff
fix issue #6916: undocument deprecated asynchat.fifo class.q
authorGiampaolo Rodola' <g.rodola@gmail.com>
Sat, 14 Jun 2014 15:03:42 +0000 (17:03 +0200)
committerGiampaolo Rodola' <g.rodola@gmail.com>
Sat, 14 Jun 2014 15:03:42 +0000 (17:03 +0200)
Doc/library/asynchat.rst
Misc/NEWS

index c6fa06162e556c18b52ea0abbc9a797ceaa0930c..794da8cced7f70b17df69bf6fb6c85ff090e09ff 100644 (file)
@@ -147,40 +147,6 @@ connection requests.
    by the channel after :meth:`found_terminator` is called.
 
 
-asynchat - Auxiliary Classes
-------------------------------------------
-
-.. class:: fifo(list=None)
-
-   A :class:`fifo` holding data which has been pushed by the application but
-   not yet popped for writing to the channel.  A :class:`fifo` is a list used
-   to hold data and/or producers until they are required.  If the *list*
-   argument is provided then it should contain producers or data items to be
-   written to the channel.
-
-
-   .. method:: is_empty()
-
-      Returns ``True`` if and only if the fifo is empty.
-
-
-   .. method:: first()
-
-      Returns the least-recently :meth:`push`\ ed item from the fifo.
-
-
-   .. method:: push(data)
-
-      Adds the given data (which may be a string or a producer object) to the
-      producer fifo.
-
-
-   .. method:: pop()
-
-      If the fifo is not empty, returns ``True, first()``, deleting the popped
-      item.  Returns ``False, None`` for an empty fifo.
-
-
 .. _asynchat-example:
 
 asynchat Example
index c7005f88fa3f7613d7bcc9519f809adf8f3cfd6b..76502f3943ec1a592b4e90fa90a9631db83cff44 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -550,6 +550,8 @@ C API
 Documentation
 -------------
 
+- Issue #6916: undocument deprecated asynchat.fifo class.
+
 - Issue #17386: Expanded functionality of the ``Doc/make.bat`` script to make
   it much more comparable to ``Doc/Makefile``.