Docstring updates to NetConfig objects.

1 files changed, 16 insertions, 0 deletions

diff --git a/os_net_config/impl_ifcfg.py b/os_net_config/impl_ifcfg.py
index 4125017..aa69cb4 100644
--- a/os_net_config/impl_ifcfg.py
+++ b/os_net_config/impl_ifcfg.py
@@ -141,6 +141,10 @@ class IfcfgNetConfig(os_net_config.NetConfig):
         logger.debug('route data: %s' % self.routes[interface_name])
 
     def add_interface(self, interface):
+        """Add an Interface object to the net config object.
+
+        :param interface: The Interface object to add.
+        """
         logger.info('adding interface: %s' % interface.name)
         data = self._add_common(interface)
         logger.debug('interface data: %s' % data)
@@ -149,6 +153,10 @@ class IfcfgNetConfig(os_net_config.NetConfig):
             self._add_routes(interface.name, interface.routes)
 
     def add_vlan(self, vlan):
+        """Add a Vlan object to the net config object.
+
+        :param vlan: The vlan object to add.
+        """
         logger.info('adding vlan: %s' % vlan.name)
         data = self._add_common(vlan)
         logger.debug('vlan data: %s' % data)
@@ -157,6 +165,10 @@ class IfcfgNetConfig(os_net_config.NetConfig):
             self._add_routes(vlan.name, vlan.routes)
 
     def add_bridge(self, bridge):
+        """Add an OvsBridge object to the net config object.
+
+        :param bridge: The OvsBridge object to add.
+        """
         logger.info('adding bridge: %s' % bridge.name)
         data = self._add_common(bridge)
         logger.debug('bridge data: %s' % data)
@@ -165,6 +177,10 @@ class IfcfgNetConfig(os_net_config.NetConfig):
             self._add_routes(bridge.name, bridge.routes)
 
     def add_bond(self, bond):
+        """Add an OvsBond object to the net config object.
+
+        :param bridge: The OvsBond object to add.
+        """
         logger.info('adding bond: %s' % bond.name)
         data = self._add_common(bond)
         logger.debug('bond data: %s' % data)