Merge pull request #206 from neutrinoceros/fix_radmc3dwriter_docstring

DOC: fix RadMC3DWriter's docstring (compat with modern yt)
yt-project · Jul 20, 2023 · 934bb9b · 934bb9b
2 parents 60bcffc + 88a6363
commit 934bb9b
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/yt_astro_analysis/radmc3d_export/RadMC3DInterface.py b/yt_astro_analysis/radmc3d_export/RadMC3DInterface.py
@@ -110,13 +110,19 @@ class RadMC3DWriter:
     included in the radiative transfer calculation by radmc3d:
 
     >>> import yt
+    >>> import unyt as un
     >>> from yt.extensions.astro_analysis.radmc3d_export.api import RadMC3DWriter
 
     >>> x_co = 1.0e-4
-    >>> mu_h = yt.Quantity(2.34e-24, 'g')
+    >>> mu_h = un.unyt_quantity(2.34e-24, 'g')
     >>> def _NumberDensityCO(field, data):
-    ...     return (x_co/mu_h)*data["Density"]
-    >>> yt.add_field("NumberDensityCO", function=_NumberDensityCO)
+    ...     return (x_co/mu_h)*data["gas", "density"]
+    >>> yt.add_field(
+    ...    ("gas", "NumberDensityCO"),
+    ...    function=_NumberDensityCO,
+    ...    sampling_type="cell",
+    ...    units="cm**-3",
+    ... )
 
     >>> ds = yt.load("galaxy0030/galaxy0030")
     >>> writer = RadMC3DWriter(ds)