summaryrefslogtreecommitdiff
path: root/doc/source/apt/cache.rst
diff options
context:
space:
mode:
authorJulian Andres Klode <jak@debian.org>2009-01-11 17:36:10 +0100
committerJulian Andres Klode <jak@debian.org>2009-01-11 17:36:10 +0100
commitc8215a931b11db1b85b977920c720479de7bf902 (patch)
tree2960bb7fa816d37badf06fa33f409cb01bc01b86 /doc/source/apt/cache.rst
parentcdc861975216d0a27bccc16aebdf1684a963727d (diff)
downloadpython-apt-c8215a931b11db1b85b977920c720479de7bf902.tar.gz
doc/source/**.rst: rst Style changes.
This changes our style to match the Python documentation.
Diffstat (limited to 'doc/source/apt/cache.rst')
-rw-r--r--doc/source/apt/cache.rst16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/source/apt/cache.rst b/doc/source/apt/cache.rst
index f3ba7d52..d96cba97 100644
--- a/doc/source/apt/cache.rst
+++ b/doc/source/apt/cache.rst
@@ -7,14 +7,17 @@ The Cache class
.. autoclass:: Cache
:members:
+ :undoc-members:
+
+ .. describe:: cache[pkgname]
+
+ Return a :class:`Package()` for the package with the name *pkgname*.
Example
^^^^^^^
The following example shows how to load the cache, update it, and upgrade
-all the packages on the system.
-
-.. code-block:: python
+all the packages on the system::
import apt
import apt.progress
@@ -40,12 +43,18 @@ Working with Filters
--------------------
.. autoclass:: Filter
:members:
+ :inherited-members:
+ :undoc-members:
.. autoclass:: MarkedChangesFilter
:members:
+ :inherited-members:
+ :undoc-members:
.. autoclass:: FilteredCache
:members:
+ :inherited-members:
+ :undoc-members:
Example
@@ -65,6 +74,5 @@ packages whose state has been changed, eg. packages marked for installation::
Exceptions
----------
.. autoexception:: FetchCancelledException
- :members:
.. autoexception:: FetchFailedException
.. autoexception:: LockFailedException