Clarify the note for UserList

This commit is contained in:
Raymond Hettinger 2012-02-01 19:00:09 -08:00
parent 1d23199791
commit c5f310c827
1 changed files with 12 additions and 3 deletions

View File

@ -83,9 +83,18 @@ provide the following attribute:
.. note:: .. note::
This module is available for backward compatibility only. If you are writing When Python 2.2 was released, many of the use cases for this class were
code that does not need to work with versions of Python earlier than Python 2.2, subsumed by the ability to subclass :class:`list` directly. However, a
please consider subclassing directly from the built-in :class:`list` type. handful of use cases remain.
This module provides a list-interface around an underlying data store. By
default, that data store is a :class:`list`; however, it can be used to wrap
a list-like interface around other objects (such as persistent storage).
In addition, this class can be mixed-in with built-in classes using multiple
inheritance. This can sometimes be useful. For example, you can inherit
from :class:`UserList` and :class:`str` at the same time. That would not be
possible with both a real :class:`list` and a real :class:`str`.
This module defines a class that acts as a wrapper around list objects. It is a This module defines a class that acts as a wrapper around list objects. It is a
useful base class for your own list-like classes, which can inherit from them useful base class for your own list-like classes, which can inherit from them