Skip to content

Commit f15ea3c

Browse files
committed
Minor changes to description of examples.
1 parent 84ada12 commit f15ea3c

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

doc/examples/README

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ Productively running SrMise requires, in basic, the following elements:
4545
2) The experimental uncertainties. In principle these should be reported with
4646
the data, but in practice experimental uncertainties are frequently not
4747
reported, or are unreliable due to details of the data reduction process.
48-
In these cases the user should specify an ad hoc value. In peak extraction
49-
an ad hoc uncertainty necessarily results in ad hoc model complexity, or,
48+
In these cases the user should specify an *ad hoc* value. In peak extraction
49+
an *ad hoc* uncertainty necessarily results in *ad hoc* model complexity, or,
5050
more precisely, a reasonable model complexity if the provided uncertainty
5151
is presumed correct. (Even when the uncertainties are known, specifying an
52-
ad hoc value can be a pragmatic tool for exploring alternate models,
52+
*ad hoc* value can be a pragmatic tool for exploring alternate models,
5353
especially in conjunction with multimodeling analysis.) Note that for both
5454
peak extraction and peak fitting the estimated uncertainties of peak
5555
parameters (i.e. location, width, intensity) are dependent on the
56-
experimental uncertainty
56+
experimental uncertainty.
5757
3) The PDF baseline. For crystalline samples the baseline is linear and can
5858
be readily estimated. For nanoparticles more effort is required as SrMise
5959
includes explicit support for only a few basic shapes, although the user
@@ -96,7 +96,7 @@ Basic:
9696
* TiO2_parameterdetail.py_
9797
Introductory script demonstrating basic use of all SrMise parameters. Of
9898
particular interest, it covers defining a crystalline baseline with
99-
explicit parameters, and assigning an ad hoc uncertainty when the
99+
explicit parameters, and assigning an *ad hoc* uncertainty when the
100100
experimental uncertainties are unreliable or unreported.
101101

102102
* TiO2_initialpeaks.py_

0 commit comments

Comments
 (0)