Add a warning that MultiPlaneConvergence
cannot be reused
#492
Labels
documentation
Improvements or additions to documentation
MultiPlaneConvergence
cannot be reused
#492
Which Section of the Documentation Needs Improving?
https://glass.readthedocs.io/stable/reference/lensing.html#glass.MultiPlaneConvergence
What Can be Improved About This Section
We should add a warning to the documentation which states that
MultiPlaneConvergence
instances cannot be reused across multiple simulations (because the iterative computation tracks state internally).How to Improve This Section
We could also add a code example, basically https://glass.readthedocs.io/stable/examples/1-basic/lensing.html with everything unrelated blanked out:
The text was updated successfully, but these errors were encountered: