Skip to content

Lack of documentation on class side-effects

While hunting down parallel_bilby#46 (closed), I discovered that the Likelihood(...prior=prior) can alter the prior that is passed into the likelihood. However, this does not appear to be clearly documented in bilby.

Side-effects of classes can be challenging to debug, hence it is recommended to add documentation about side-effects: https://realpython.com/documenting-python-code/