Merge pull request #1053 from rahkumar651991/doc_edit

Modify the docstring for proper return value for sw.install

lib/jnpr/junos/factory/optable.py

@@ -91,7 +91,7 @@ def generate_sax_parser_input(obj):
     """
     Used to generate xml object from Table/view to be used in SAX parsing
     Args:
-        obj: self object which contains table/view details
+    obj: self object which contains table/view details
 
     Returns: lxml etree object to be used as sax parser input
 

lib/jnpr/junos/utils/config.py

@@ -177,8 +177,9 @@ def commit_check(self, **kvargs):
         Perform a commit check.  If the commit check passes, this function
         will return ``True``.  If the commit-check results in warnings, they
         are reported and available in the Exception errs.
+
         :param int timeout: If provided the command will wait for completion
-                            using the provided value as timeout (seconds).       
+                            using the provided value as timeout (seconds).
 
         :returns: ``True`` if commit-check is successful (no errors)
         :raises CommitError: When errors detected in candidate configuration.

lib/jnpr/junos/utils/sw.py

@@ -851,9 +851,9 @@ def myprogress(dev, report):
           (Optional) Additional keyword arguments are passed through to the
           "package add" RPC.
 
-        :returns:
-            * ``True`` when the installation is successful
-            * ``False`` otherwise
+        :returns: tuple(<status>, <msg>)
+            * status : ``True`` when the installation is successful and ``False`` otherwise
+            * msg : msg received as response or error message created
         """
         if issu is True and nssu is True:
             raise TypeError("install function can either take issu or nssu not both")
@@ -1206,7 +1206,7 @@ def halt(self, in_min=0, at=None, all_re=True, other_re=False):
             then the action is performed on the other REs in the system.
 
         :returns:
-            *rpc response message (string) if command successful
+            * rpc response message (string) if command successful
         """
         if self._dev.facts["_is_linux"]:
             cmd = E("request-shutdown-halt")