[Python-checkins] cpython: fix issue #6916: undocument deprecated asynchat.fifo class.q

giampaolo.rodola python-checkins at python.org
Sat Jun 14 17:04:12 CEST 2014


http://hg.python.org/cpython/rev/42a645d74e9d
changeset:   91175:42a645d74e9d
user:        Giampaolo Rodola' <g.rodola at gmail.com>
date:        Sat Jun 14 17:03:42 2014 +0200
summary:
  fix issue #6916: undocument deprecated asynchat.fifo class.q

files:
  Doc/library/asynchat.rst |  34 ----------------------------
  Misc/NEWS                |   2 +
  2 files changed, 2 insertions(+), 34 deletions(-)


diff --git a/Doc/library/asynchat.rst b/Doc/library/asynchat.rst
--- a/Doc/library/asynchat.rst
+++ b/Doc/library/asynchat.rst
@@ -147,40 +147,6 @@
    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
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -550,6 +550,8 @@
 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``.
 

-- 
Repository URL: http://hg.python.org/cpython


More information about the Python-checkins mailing list