Cleanup and docs

nifty5/library/adjust_variances.py

@@ -16,7 +16,6 @@
 # NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
 
 from ..minimization.energy_adapter import EnergyAdapter
-from ..multi_domain import MultiDomain
 from ..multi_field import MultiField
 from ..operators.distributors import PowerDistributor
 from ..operators.energy_operators import Hamiltonian, InverseGammaLikelihood
@@ -35,25 +34,27 @@ def make_adjust_variances(a,
     Constructs a Hamiltonian to solve constant likelihood optimizations of the
     form phi = a * xi under the constraint that phi remains constant.
 
+    FIXME xi is white.
+
     Parameters
     ----------
     a : Operator
-        Operator which gives the amplitude when evaluated at a position
+        Gives the amplitude when evaluated at a position.
     xi : Operator
-        Operator which gives the excitation when evaluated at a position
+        Gives the excitation when evaluated at a position.
     postion : Field, MultiField
-        Position of the whole problem
+        Position of the whole problem.
     samples : Field, MultiField
-        Residual samples of the whole problem
+        Residual samples of the whole problem.
     scaling : Float
-        Optional rescaling of the Likelihood
+        Optional rescaling of the Likelihood.
     ic_samp : Controller
-        Iteration Controller for Hamiltonian
+        Iteration Controller for Hamiltonian.
 
     Returns
     -------
-    Hamiltonian
-        A Hamiltonian that can be used for further minimization
+    Energy
+        Hamiltonian that can be used for further minimization.
     """
 
     d = a*xi
@@ -79,6 +80,9 @@ def do_adjust_variances(position,
                         minimizer,
                         xi_key='xi',
                         samples=[]):
+    '''
+    FIXME
+    '''
 
     h_space = position[xi_key].domain[0]
     pd = PowerDistributor(h_space, amplitude_operator.target[0])