From eef441c1acdf1d3d483647b153f721cbab4a8517 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Wed, 7 Aug 2013 14:20:55 -0400 Subject: Plugin: added missing docstring --- src/lib/Bcfg2/Server/Plugin/interfaces.py | 11 +++++++++++ 1 file changed, 11 insertions(+) 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 -- cgit v1.2.3-1-g7c22