diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-08-07 14:20:55 -0400 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-08-07 14:20:55 -0400 |
| commit | eef441c1acdf1d3d483647b153f721cbab4a8517 (patch) | |
| tree | 4eec5b86acf420c47451bbba5b7693743ae74b49 /src/lib/Bcfg2/Server/Plugin | |
| parent | 4b09a72355d6fea244ad6b8dcfb2fd151a5ada6b (diff) | |
| download | bcfg2-eef441c1acdf1d3d483647b153f721cbab4a8517.tar.gz bcfg2-eef441c1acdf1d3d483647b153f721cbab4a8517.tar.bz2 bcfg2-eef441c1acdf1d3d483647b153f721cbab4a8517.zip | |
Plugin: added missing docstring
Diffstat (limited to 'src/lib/Bcfg2/Server/Plugin')
| -rw-r--r-- | src/lib/Bcfg2/Server/Plugin/interfaces.py | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/lib/Bcfg2/Server/Plugin/interfaces.py b/src/lib/Bcfg2/Server/Plugin/interfaces.py index 2dbf75f42..376030792 100644 --- a/src/lib/Bcfg2/Server/Plugin/interfaces.py +++ b/src/lib/Bcfg2/Server/Plugin/interfaces.py @@ -605,4 +605,15 @@ class Caching(object): FAM. This presents a unified interface to clear the cache. """ def expire_cache(self, key=None): + """ Expire the cache associated with the given key. + + :param key: The key to expire the cache for. Because cache + implementations vary tremendously between plugins, + this could be any number of things, but generally + a hostname. It also may or may not be possible to + expire the cache for a single host; this interface + does not require any guarantee about that. + :type key: varies + :returns: None + """ raise NotImplementedError |