summaryrefslogtreecommitdiffstats
path: root/src/lib/Bcfg2/Server/Plugin
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2012-09-19 10:06:00 -0400
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2012-09-19 10:06:00 -0400
commit159da3b0dd3c0a8c4811183eaff37dc9148313bb (patch)
tree381f88ba5ec0e0a31c5477caadc007e3d1a9b0c9 /src/lib/Bcfg2/Server/Plugin
parentb9870f2e9293491a2f17b1c3bbd4e1bc2d505704 (diff)
downloadbcfg2-159da3b0dd3c0a8c4811183eaff37dc9148313bb.tar.gz
bcfg2-159da3b0dd3c0a8c4811183eaff37dc9148313bb.tar.bz2
bcfg2-159da3b0dd3c0a8c4811183eaff37dc9148313bb.zip
better docs for base Metadata class
Diffstat (limited to 'src/lib/Bcfg2/Server/Plugin')
-rw-r--r--src/lib/Bcfg2/Server/Plugin/interfaces.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/lib/Bcfg2/Server/Plugin/interfaces.py b/src/lib/Bcfg2/Server/Plugin/interfaces.py
index 626f82a2d..ea0b50233 100644
--- a/src/lib/Bcfg2/Server/Plugin/interfaces.py
+++ b/src/lib/Bcfg2/Server/Plugin/interfaces.py
@@ -83,7 +83,10 @@ class Structure(object):
class Metadata(object):
- """Signal metadata capabilities for this plugin"""
+ """ Metadata plugins handle initial metadata construction,
+ accumulating data from :class:`Connector` plugins, and producing
+ :class:`Bcfg2.Server.Plugins.Metadata.ClientMetadata` objects. """
+
def viz(self, hosts, bundles, key, only_client, colors):
""" Return a string containing a graphviz document that maps
out the Metadata for :ref:`bcfg2-admin viz <server-admin-viz>`