Skip to content

Commit

Permalink
docs: improve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
yucongalicechen committed Dec 30, 2024
1 parent 953e187 commit dd52ad9
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/diffpy/utils/tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -218,13 +218,14 @@ def compute_mu_using_xraydb(sample_composition, energy, sample_mass_density=None
Parameters
----------
sample_composition : str
The chemical formula or the name of the material.
The chemical formula of the material.
energy : float
The energy of the incident x-rays in keV.
sample_mass_density : float, optional, Default is None
The mass density of the packed powder/sample in gr/cm^3.
The mass density of the packed powder/sample in g/cm*3.
packing_fraction : float, optional, Default is None
The fraction of sample in the capillary (between 0 and 1).
Specify either sample_mass_density or packing_fraction but not both.
Returns
-------
Expand Down

0 comments on commit dd52ad9

Please sign in to comment.