Add docstring, rename function

Author: Sparks29032

src/diffpy/morph/morph_io.py

@@ -34,7 +34,7 @@ def custom_formatwarning(msg, *args, **kwargs):
 warnings.formatwarning = custom_formatwarning
 
 
-def get_morph_inputs(
+def build_morph_inputs_container(
     scale,
     stretch,
     smear_pdf,
@@ -62,6 +62,17 @@ def get_morph_inputs(
         opts.vshift
     squeeze
         opts.squeeze
+
+    Returns
+    -------
+    dict
+        Dictionary of input morphing parameters.
+        Only one of smear and smear_pdf is included
+        (takes smear_pdf over smear when both exist).
+        Does not include hshift if a degree zero
+        or above squeeze is used.
+        Does not include stretch if a degree one
+        or above squeeze is used.
     """
     squeeze_poly_deg = -1
     squeeze_in = None

src/diffpy/morph/morphapp.py

@@ -725,7 +725,7 @@ def single_morph(
     # if you think there requires special handling
 
     # Input morph parameters
-    morph_inputs = io.get_morph_inputs(
+    morph_inputs = io.build_morph_inputs_container(
         opts.scale,
         opts.stretch,
         opts.smear_pdf,
@@ -952,7 +952,7 @@ def multiple_targets(parser, opts, pargs, stdout_flag=True, python_wrap=False):
     for key in morph_results.keys():
         target_file_names.append(key)
 
-    morph_inputs = io.get_morph_inputs(
+    morph_inputs = io.build_morph_inputs_container(
         opts.scale,
         opts.stretch,
         opts.smear_pdf,
@@ -1138,7 +1138,7 @@ def multiple_morphs(parser, opts, pargs, stdout_flag=True, python_wrap=False):
     for key in morph_results.keys():
         morph_file_names.append(key)
 
-    morph_inputs = io.get_morph_inputs(
+    morph_inputs = io.build_morph_inputs_container(
         opts.scale,
         opts.stretch,
         opts.smear_pdf,