Skip to content

Commit

Permalink
Update dicstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
hsinfan1996 committed Jul 28, 2023
1 parent 6b58996 commit 19a6be7
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions clmm/theory/parent_class.py
Original file line number Diff line number Diff line change
Expand Up @@ -376,9 +376,11 @@ def set_halo_density_profile(self, halo_profile_model="nfw", massdef="mean", del
Parameters
----------
halo_profile_model: str
Halo mass profile, current options are 'nfw' (letter case independent)
Halo mass profile, current options are 'nfw', 'einasto', 'hernquist'
(letter case independent)
massdef: str
Mass definition, current options are 'mean' (letter case independent)
Mass definition, current options are 'mean', 'critical', 'virial'
(letter case independent)
delta_mdef: int
Overdensity number
"""
Expand Down Expand Up @@ -477,8 +479,8 @@ def eval_critical_surface_density_eff(self, z_len, pzbins, pzpdf):
This comes from the maximum likelihood estimator for evaluating a
:math:`\Delta\Sigma` profile.
For the standard :math:`\Sigma_{\rm crit}(z)` definition, use the `eval_sigma_crit` method
of the CLMM cosmology object.
For the standard :math:`\Sigma_{\text{crit}}(z)` definition, use the `eval_sigma_crit`
method of the CLMM cosmology object.
Parameters
----------
Expand Down

0 comments on commit 19a6be7

Please sign in to comment.