Skip to content

Commit

Permalink
docs: fix GSL in examples
Browse files Browse the repository at this point in the history
Signed-off-by: nstarman <[email protected]>
  • Loading branch information
nstarman committed Jul 9, 2024
1 parent a0c67d5 commit b52fb4b
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/galax/_galax_interop_gala/potential.py
Original file line number Diff line number Diff line change
Expand Up @@ -910,6 +910,12 @@ def galax_to_gala(pot: gpx.PowerLawCutoffPotential, /) -> gp.PowerLawCutoffPoten
Examples
--------
.. invisible-code-block: python
from galax.utils._optional_deps import GSL_ENABLED
.. skip: start if(not GSL_ENABLED, reason="requires GSL")
>>> import gala.potential as galap
>>> from unxt import Quantity
>>> import galax.potential as gp
Expand All @@ -918,6 +924,7 @@ def galax_to_gala(pot: gpx.PowerLawCutoffPotential, /) -> gp.PowerLawCutoffPoten
>>> gp.io.convert_potential(gp.io.GalaLibrary, pot)
<PowerLawCutoffPotential: m=1.00e+11, alpha=1.80, r_c=20.00 (kpc,Myr,solMass,rad)>
.. skip: end
""" # noqa: E501
_error_if_not_all_constant_parameters(pot, *pot.parameters.keys())

Expand Down

0 comments on commit b52fb4b

Please sign in to comment.