[Documentation][zos_encode] Add and standarize docstrings on modules/zos_encode.py (#1348)

* Add and standarize docstrings on modules/zos_encode.py

* Create changelog fragment

* Modify google style to numpy

* Standarize numpy style

* Updated docstrings

---------

Co-authored-by: Fernando Flores <[email protected]>

Author: IsaacVRey

changelogs/fragments/1348-update-docstring-zos_encode.yml

@@ -0,0 +1,3 @@
+trivial:
+  - zos_encode - Updated docstrings to numpy style for visual aid to developers.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1348).

plugins/modules/zos_encode.py

@@ -295,6 +295,25 @@
 
 
 def check_pds_member(ds, mem):
+    """Check if a member exists in a PDS.
+
+    Parameters
+    ----------
+    ds : str
+        PDS data set name.
+    mem : str
+        Member name to check if is under PDS.
+
+    Returns
+    -------
+    bool
+        If it is a member of the data set.
+
+    Raises
+    ------
+    EncodeError
+        Can not find member in provided dataset.
+    """
     check_rc = False
     if mem in datasets.list_members(ds):
         check_rc = True
@@ -304,7 +323,25 @@ def check_pds_member(ds, mem):
 
 
 def check_mvs_dataset(ds):
-    """ To call data_set utils to check if the MVS data set exists or not """
+    """To call data_set utils to check if the MVS data set exists or not.
+
+    Parameters
+    ----------
+    ds : str
+        Data set name.
+
+    Returns
+    -------
+    tuple(bool,str)
+        If the data set exists and it's type.
+
+    Raises
+    ------
+    EncodeError
+        If data set is not cataloged.
+    EncodeError
+        Unable to determine data set type.
+    """
     check_rc = False
     ds_type = None
     if not data_set.DataSet.data_set_exists(ds):
@@ -321,7 +358,23 @@ def check_mvs_dataset(ds):
 
 
 def check_file(file):
-    """ check file is a USS file or an MVS data set """
+    """Check file is a USS file or an MVS data set.
+
+    Parameters
+    ----------
+    file : str
+        File to check.
+
+    Returns
+    -------
+    tuple(bool,bool,str)
+        If is USS file, MVS dataset, and the dataset type.
+
+    Raises
+    ------
+    EncodeError
+        The data set is not partitioned.
+    """
     is_uss = False
     is_mvs = False
     ds_type = None
@@ -347,6 +400,18 @@ def check_file(file):
 
 
 def verify_uss_path_exists(file):
+    """Verify if USS path exists.
+
+    Parameters
+    ----------
+    file : str
+        Path of the file.
+
+    Raises
+    ------
+    EncodeError
+        File does not exist in the directory.
+    """
     if not path.exists(file):
         mypath = "/" + file.split("/")[0] + "/*"
         ld = listdir(mypath)
@@ -359,6 +424,13 @@ def verify_uss_path_exists(file):
 
 
 def run_module():
+    """Runs the module.
+
+    Raises
+    ------
+    fail_json
+        Exception during execution.
+    """
     module_args = dict(
         src=dict(type="str", required=True),
         dest=dict(type="str"),
@@ -530,6 +602,18 @@ def run_module():
 
 class EncodeError(Exception):
     def __init__(self, message):
+        """Error during encoding.
+
+        Parameters
+        ----------
+        message : str
+            Human readable string describing the exception.
+
+        Attributes
+        ----------
+        msg : str
+            Human readable string describing the exception.
+        """
         self.msg = 'An error occurred during encoding: "{0}"'.format(message)
         super(EncodeError, self).__init__(self.msg)