docs: formatting of docstrings improved.

This commit is contained in:
Fabian Joswig 2022-03-05 08:43:57 +00:00
parent 6bd3868179
commit 57a45e271f
2 changed files with 15 additions and 5 deletions

View file

@ -1300,6 +1300,8 @@ def correlate(obs_a, obs_b):
obs_b : Obs
Second observable
Notes
-----
Keep in mind to only correlate primary observables which have not been reweighted
yet. The reweighting has to be applied after correlating the observables.
Currently only works if ensembles are identical (this is not strictly necessary).
@ -1496,6 +1498,8 @@ def merge_obs(list_of_obs):
list_of_obs : list
list of the Obs object to be combined
Notes
-----
It is not possible to combine obs which are based on the same replicum
"""
replist = [item for obs in list_of_obs for item in obs.names]