Add documentation for vectorize_fn3
@@ -160,9 +160,17 @@ def _vectorize_fn2(fn, fn_vec, cosmo, x, z, returns_status=True):
return f
def _vectorize_fn3(fn, fn_vec, cosmo, x, n, returns_status=True):
- """
- Generic wrapper to allow vectorized (1D array) access to CCL functions with
- one vector argument and one integer argument.
+ """Generic wrapper to allow vectorized (1D array) access to CCL functions with
+ one vector argument and one integer argument, with a cosmology dependence.
+
+ Args:
+ fn (callable): Function with a single argument.
+ fn_vec (callable): Function that has a vectorized implementation in a .i file.
+ cosmo (ccl_cosmology or Cosmology): The input cosmology which gets converted to a ccl_cosmology.
+ x (float or array_like): Argument to fn.
+ n (int): Integer argument to fn.
+ returns_stats (bool): Indicates whether fn returns a status.
+
"""
# Access ccl_cosmology object
cosmo = _cosmology_obj(cosmo)
