synchronize docstrings

mpisppy/scenario_tree.py

@@ -63,16 +63,22 @@ class ScenarioNode:
       stage (int): stage number (root is 1)
       cost_expression (pyo Expression or Var):  stage cost 
       nonant_list (list of pyo Var, VarData or slices): the Vars that
-              require nonanticipativity at the node (might not be a list)
+            require nonanticipativity at the node (might not be a list)
       scen_model (pyo concrete model): the (probably not 'a') concrete model
-      nonant_ef_suppl_list (list of pyo Var, VarData or slices):
-              vars for which nonanticipativity constraints tighten the EF
-              (important for bundling)
+      nonant_ef_suppl_list (list of pyo Var, Vardata or slices):
+            Vars for which nonanticipativity constraints will only be added to
+            the extensive form (important for bundling), but for which mpi-sppy
+            will not enforce them as nonanticipative elsewhere.
+            NOTE: These types of variables are often indicator variables
+                  that are already present in the deterministic model.
       surrogate_nonant_list (list of pyo Var, VarData or slices):
-              vars for which nonanticipativity constraints are enforced implicitly
-              but which may speed PH convergence and/or aid in cut generation.
-              These vars will be ignored for fixers, incumbent finders which
-              fix nonants to calculate solutions, and the EF creator
+            Vars for which nonanticipativity constraints are enforced implicitly
+            by the vars in varlist, but which may speed PH convergence and/or
+            aid in cut generation when considered explicitly.
+            These vars will be ignored for fixers, incumbent finders which
+            fix nonants to calculate solutions, and the EF creator.
+            NOTE: These types of variables are typically artificially added
+                  to the model to capture hierarchical model features.
       parent_name (str): name of the parent node      
 
     Lists:

mpisppy/utils/sputils.py

@@ -910,15 +910,15 @@ def attach_root_node(model, firstobj, varlist, nonant_ef_suppl_list=None, surrog
               the extensive form (important for bundling), but for which mpi-sppy
               will not enforce them as nonanticipative elsewhere.
               NOTE: These types of variables are often indicator variables
-                          that are already present in the deterministic model.
+                    that are already present in the deterministic model.
         surrogate_nonant_list (list of pyo Var, VarData or slices):
               Vars for which nonanticipativity constraints are enforced implicitly
               by the vars in varlist, but which may speed PH convergence and/or
               aid in cut generation when considered explicitly.
               These vars will be ignored for fixers, incumbent finders which
               fix nonants to calculate solutions, and the EF creator.
               NOTE: These types of variables are typically artificially added
-                          to the model to capture hierarchical model features.
+                    to the model to capture hierarchical model features.
         do_uniform (boolean): controls a side-effect to deal with missing probs
 
     Note: