From cb770fdfebb4d196c45cbff524715fd5d1d8a0a5 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Mon, 28 Mar 2011 11:41:56 -0500 Subject: doc: Typo fix from euth Signed-off-by: Sol Jerome --- doc/development/plugins.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/development') diff --git a/doc/development/plugins.txt b/doc/development/plugins.txt index 709b9fcec..4c723f7e9 100644 --- a/doc/development/plugins.txt +++ b/doc/development/plugins.txt @@ -139,7 +139,7 @@ Example Plugin __version__ = '1' __author__ = 'me@me.com' __rmi__ = ['myfunction'] - # myfunction is not available remotely as MyPlugin.myfunction + # myfunction is now available remotely as MyPlugin.myfunction def __init__(self, core, datastore): Bcfg2.Server.Plugin.Plugin.__init__(self, core, datastore) @@ -206,8 +206,8 @@ do so. We will call our new plugin `MyMetadata`. __version__ = '$Id$' __author__ = 'bcfg-dev@mcs.anl.gov' - def __init__(self, core, datastore, watch_clients=True): - Bcfg2.Server.Plugins.Metadata.Metadata.__init__(self, core, datastore, watch_clients) + def __init__(self, core, datastore, watch_clients=True): + Bcfg2.Server.Plugins.Metadata.Metadata.__init__(self, core, datastore, watch_clients) #. Add MyMetadata to ``src/lib/Server/Plugins/__init__.py`` #. Replace Metadata with MyMetadata in the plugins line of bcfg2.conf -- cgit v1.2.3-1-g7c22 From 03de142cfaad298124658698aba63b88d090d4fc Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Fri, 15 Apr 2011 13:55:01 -0500 Subject: doc: Remove unnecessary step for writing tool drivers Signed-off-by: Sol Jerome --- doc/development/client-driver.txt | 1 - 1 file changed, 1 deletion(-) (limited to 'doc/development') diff --git a/doc/development/client-driver.txt b/doc/development/client-driver.txt index cc065dd32..32bb0aff4 100644 --- a/doc/development/client-driver.txt +++ b/doc/development/client-driver.txt @@ -10,7 +10,6 @@ driver for a configuration element type. The included example describes an existing driver, and the process that was used to create it. #. Pick a name for the driver. In this case, we picked the name RPM. -#. Add "RPM" to the ``__all__`` list in ``src/lib/Client/Tools/__init__.py`` #. Create a file in ``src/lib/Client/Tools`` with the same name (RPM.py) #. Create a class in this file with the same name (class RPM) -- cgit v1.2.3-1-g7c22 From e9047ac894dc064a34bd8026f49fc186121b6cfc Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Sat, 23 Apr 2011 21:54:41 -0500 Subject: doc: Update style guide with Section header information Signed-off-by: Sol Jerome --- doc/development/docstyleguide.txt | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc/development') diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt index fda1037f3..59db58362 100644 --- a/doc/development/docstyleguide.txt +++ b/doc/development/docstyleguide.txt @@ -25,3 +25,9 @@ Basics When used alone this refers to a Bcfg2 :term:`repository`. When there is a chance for confusion, for instance in documents also talking about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`. + +Sections +-------- + +Unless necessary, all the documentation follows the sections header +rules available at http://docs.python.org/documenting/rest.html#sections. -- cgit v1.2.3-1-g7c22