more doc updates

[ncclient] / ncclient / operations / edit.py

diff --git a/ncclient/operations/edit.py b/ncclient/operations/edit.py
index 2f93b34..a2dbd94 100644 (file)
--- a/ncclient/operations/edit.py
+++ b/ncclient/operations/edit.py
@@ -19,16 +19,29 @@ from rpc import RPC
 import util
 
 import logging
+
 logger = logging.getLogger("ncclient.operations.edit")
 
 "Operations related to changing device configuration"
 
 class EditConfig(RPC):
+    "`edit-config` RPC"
+
+    def request(self, target, config, default_operation=None, test_option=None, error_option=None):
+        """Loads all or part of the specified *config* to the *target* configuration datastore.
+
+        *target* is the name of the configuration datastore being edited
+
+        *config* is the configuration, which must be rooted in the `config` element. It can be specified either as a string or an :class:`~xml.etree.ElementTree.Element`.
+
+        *default_operation* if specified must be one of { `"merge"`, `"replace"`, or `"none"` }
+
+        *test_option* if specified must be one of { `"test_then_set"`, `"set"` }
 
-    "*<edit-config>* RPC"
-    
-    def request(self, target, config, default_operation=None, test_option=None,
-                error_option=None):
+        *error_option* if specified must be one of { `"stop-on-error"`, `"continue-on-error"`, `"rollback-on-error"` }
+
+        The `"rollback-on-error"` *error_option* depends on the `:rollback-on-error` capability.
+        """
         node = new_ele("edit-config")
         node.append(util.datastore_or_url("target", target, self._assert))
         if error_option is not None:
@@ -39,27 +52,38 @@ class EditConfig(RPC):
             self._assert(':validate')
             sub_ele(node, "test-option").text = test_option
         if default_operation is not None:
-            # TODO: check if it is a valid default-operation
+        # TODO: check if it is a valid default-operation
             sub_ele(node, "default-operation").text = default_operation
         node.append(validated_element(config, ("config", qualify("config"))))
         return self._request(node)
 
 
 class DeleteConfig(RPC):
-
-    "*<delete-config>* RPC"
+    "`delete-config` RPC"
 
     def request(self, target):
+        """Delete a configuration datastore.
+
+        *target* specifies the  name or URL of configuration datastore to delete
+
+        :seealso: :ref:`srctarget_params`"""
         node = new_ele("delete-config")
         node.append(util.datastore_or_url("target", target, self._assert))
         return self._request(node)
 
 
 class CopyConfig(RPC):
+    "`copy-config` RPC"
 
-    "*<copy-config>* RPC"
-    
     def request(self, source, target):
+        """Create or replace an entire configuration datastore with the contents of another complete
+        configuration datastore.
+
+        *source* is the name of the configuration datastore to use as the source of the copy operation or `config` element containing the configuration subtree to copy
+
+        *target* is the name of the configuration datastore to use as the destination of the copy operation
+
+        :seealso: :ref:`srctarget_params`"""
         node = new_ele("copy-config")
         node.append(util.datastore_or_url("target", target, self._assert))
         node.append(util.datastore_or_url("source", source, self._assert))
@@ -67,12 +91,16 @@ class CopyConfig(RPC):
 
 
 class Validate(RPC):
-
-    "*<validate>* RPC. Depends on the *:validate* capability."
+    "`validate` RPC. Depends on the `:validate` capability."
 
     DEPENDS = [':validate']
 
     def request(self, source):
+        """Validate the contents of the specified configuration.
+
+        *source* is the name of the configuration datastore being validated or `config` element containing the configuration subtree to be validated
+
+        :seealso: :ref:`srctarget_params`"""
         node = new_ele("validate")
         try:
             src = validated_element(source, ("config", qualify("config")))
@@ -84,27 +112,32 @@ class Validate(RPC):
 
 
 class Commit(RPC):
-
-    "*<commit>* RPC. Depends on the *:candidate* capability, and the *:confirmed-commit* "
+    "`commit` RPC. Depends on the `:candidate` capability, and the `:confirmed-commit`."
 
     DEPENDS = [':candidate']
-    
+
     def request(self, confirmed=False, timeout=None):
+        """Commit the candidate configuration as the device's new current configuration. Depends on the `:candidate` capability.
+
+        A confirmed commit (i.e. if *confirmed* is `True`) is reverted if there is no followup commit within the *timeout* interval. If no timeout is specified the confirm timeout defaults to 600 seconds (10 minutes). A confirming commit may have the *confirmed* parameter but this is not required. Depends on the `:confirmed-commit` capability.
+
+        *confirmed* whether this is a confirmed commit
+
+        *timeout* specifies the confirm timeout in seconds"""
         node = new_ele("commit")
         if confirmed:
             self._assert(":confirmed-commit")
             sub_ele(node, "confirmed")
             if timeout is not None:
-                # TODO check if timeout is a valid integer?
                 sub_ele(node, "confirm-timeout").text = timeout
         return self._request(node)
 
 
 class DiscardChanges(RPC):
-
-    "*<discard-changes>* RPC. Depends on the *:candidate* capability."
+    "`discard-changes` RPC. Depends on the `:candidate` capability."
 
     DEPENDS = [":candidate"]
 
     def request(self):
+        """Revert the candidate configuration to the currently running configuration. Any uncommitted changes are discarded."""
         return self._request(new_ele("discard-changes"))
\ No newline at end of file