Skip to content

Commit e49358a

Browse files
committed
Skip help() examples when running doctest
1 parent 7212702 commit e49358a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -99,34 +99,34 @@ You can access documentation in the interpreter with Python's built-in help
9999
function::
100100

101101
>>> import diskcache
102-
>>> help(diskcache)
102+
>>> help(diskcache) # doctest: +SKIP
103103

104104
The core of `DiskCache`_ is three data types intended for caching. `Cache`_
105105
objects manage a SQLite database and filesystem directory to store key and
106106
value pairs. `FanoutCache`_ provides a sharding layer to utilize multiple
107107
caches and `DjangoCache`_ integrates that with `Django`_::
108108

109109
>>> from diskcache import Cache, FanoutCache, DjangoCache
110-
>>> help(Cache)
111-
>>> help(FanoutCache)
112-
>>> help(DjangoCache)
110+
>>> help(Cache) # doctest: +SKIP
111+
>>> help(FanoutCache) # doctest: +SKIP
112+
>>> help(DjangoCache) # doctest: +SKIP
113113

114114
Built atop the caching data types, are `Deque`_ and `Index`_ which work as a
115115
cross-process, persistent replacements for Python's ``collections.deque`` and
116116
``dict``. These implement the sequence and mapping container base classes::
117117

118118
>>> from diskcache import Deque, Index
119-
>>> help(Deque)
120-
>>> help(Index)
119+
>>> help(Deque) # doctest: +SKIP
120+
>>> help(Index) # doctest: +SKIP
121121

122122
Finally, a number of `recipes`_ for cross-process synchronization are provided
123123
using an underlying cache. Features like memoization with cache stampede
124124
prevention, cross-process locking, and cross-process throttling are available::
125125

126126
>>> from diskcache import memoize_stampede, Lock, throttle
127-
>>> help(memoize_stampede)
128-
>>> help(Lock)
129-
>>> help(throttle)
127+
>>> help(memoize_stampede) # doctest: +SKIP
128+
>>> help(Lock) # doctest: +SKIP
129+
>>> help(throttle) # doctest: +SKIP
130130

131131
Python's docstrings are a quick way to get started but not intended as a
132132
replacement for the `DiskCache Tutorial`_ and `DiskCache API Reference`_.

0 commit comments

Comments
 (0)