Skip to content

Commit edece58

Browse files
authored
fix vale_ostriker documentation warnings (#340)
1 parent ec32483 commit edece58

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

skypy/halo/abundance_matching.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,18 @@
2626
def vale_ostriker(halo_kwargs, subhalo_kwargs, galaxy_kwargs):
2727
"""Vale & Ostriker abundance matching.
2828
Generate matched arrays of (sub)halos masses and galaxy absolute magnitudes
29-
following the abundance matching model in Vale & Ostriker (2004).
29+
following the abundance matching model in [1]_.
3030
3131
Parameters
3232
----------
3333
halo_kwargs : dict
34-
Dictionary of keyword arguments for skypy.halo.press_schechter.
34+
Dictionary of keyword arguments for `~skypy.halo.mass.press_schechter`.
3535
subhalo_kwargs : dict
36-
Dictionary of keyword arguments for skypy.halo.number_subhalos and
37-
skypy.halo.subhalo_mass_sampler.
36+
Dictionary of keyword arguments for `~skypy.halo.mass.number_subhalos`
37+
and `~skypy.halo.mass.subhalo_mass_sampler`.
3838
galaxy_kwargs : dict
39-
Dictionary of keyword arguments for skypy.galaxy.schechter_lf_magnitude.
39+
Dictionary of keyword arguments for
40+
`~skypy.galaxy.luminosity.schechter_lf_magnitude`.
4041
4142
Returns
4243
-------
@@ -48,6 +49,7 @@ def vale_ostriker(halo_kwargs, subhalo_kwargs, galaxy_kwargs):
4849
Array of boolean values indicating if the halo is a parent.
4950
magnitude : array_like
5051
Array of galaxy absolute magnitudes.
52+
5153
References
5254
----------
5355
.. [1] Vale A., Ostriker J. P., 2004, MNRAS, 353, 189

0 commit comments

Comments
 (0)