Skip to content

Commit dd52ad9

Browse files
docs: improve docstring
1 parent 953e187 commit dd52ad9

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/diffpy/utils/tools.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -218,13 +218,14 @@ def compute_mu_using_xraydb(sample_composition, energy, sample_mass_density=None
218218
Parameters
219219
----------
220220
sample_composition : str
221-
The chemical formula or the name of the material.
221+
The chemical formula of the material.
222222
energy : float
223223
The energy of the incident x-rays in keV.
224224
sample_mass_density : float, optional, Default is None
225-
The mass density of the packed powder/sample in gr/cm^3.
225+
The mass density of the packed powder/sample in g/cm*3.
226226
packing_fraction : float, optional, Default is None
227227
The fraction of sample in the capillary (between 0 and 1).
228+
Specify either sample_mass_density or packing_fraction but not both.
228229
229230
Returns
230231
-------

0 commit comments

Comments
 (0)