Skip to content

Commit 476bd25

Browse files
committed
Update help menu tips
1 parent 9534053 commit 476bd25

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

src/diffpy/pdfmorph/pdfmorphapp.py

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,12 @@ def custom_error(self, msg):
5353
"Use --help for help.",
5454
]
5555
),
56-
epilog="Please report bugs to diffpy-dev@googlegroups.com.",
56+
epilog="\n".join(
57+
[
58+
"For more information, see the PDFmorph manual."
59+
"Please report bugs to diffpy-dev@googlegroups.com.",
60+
]
61+
),
5762
)
5863

5964
parser.add_option("-V", "--version", action="version", help="Show program version and exit.")
@@ -140,7 +145,7 @@ def custom_error(self, msg):
140145
"--qdamp",
141146
type="float",
142147
metavar="QDAMP",
143-
help="Dampen PDF by a factor QDAMP. (See PDFGui manual.)",
148+
help="Dampen PDF by a factor QDAMP.",
144149
)
145150
group.add_option(
146151
"--radius",
@@ -196,18 +201,18 @@ def custom_error(self, msg):
196201
"--mlabel",
197202
metavar="MLABEL",
198203
dest="mlabel",
199-
help="Set label for morphed data to MLABEL on plot. Ignored if using file names as labels.",
204+
help="Set label for morphed data to MLABEL on plot. Default label is FILE1.",
200205
)
201206
group.add_option(
202207
"--tlabel",
203208
metavar="TLABEL",
204209
dest="tlabel",
205-
help="Set label for target data to TLABEL on plot. Ignored if using file names as labels.",
210+
help="Set label for target data to TLABEL on plot. Default label is FILE2.",
206211
)
207212
group.add_option("--pmin", type="float", help="Minimum r-value to plot. Defaults to RMIN.")
208213
group.add_option("--pmax", type="float", help="Maximum r-value to plot. Defaults to RMAX.")
209-
group.add_option("--maglim", type="float", help="Magnify plot curves beyond MAGLIM by MAG.")
210-
group.add_option("--mag", type="float", help="Magnify plot curves beyond MAGLIM by MAG.")
214+
group.add_option("--maglim", type="float", help="Magnify plot curves beyond r=MAGLIM by MAG.")
215+
group.add_option("--mag", type="float", help="Magnify plot curves beyond r=MAGLIM by MAG.")
211216
group.add_option("--lwidth", type="float", help="Line thickness of plotted curves.")
212217

213218
# Multiple morph options
@@ -231,7 +236,9 @@ def custom_error(self, msg):
231236
"--sort-by",
232237
metavar="FIELD",
233238
dest="field",
234-
help="""Used with --multiple to sort files in DIRECTORY by FIELD from lowest to highest.
239+
help="""Used with --multiple to sort files in DIRECTORY by FIELD.
240+
If the FIELD being used has a numerical value, sort from lowest to highest.
241+
Otherwise, sort in ASCII sort order.
235242
FIELD must be included in the header of all the PDF files.""",
236243
)
237244
group.add_option(
@@ -255,19 +262,19 @@ def custom_error(self, msg):
255262
Specify names for each manipulated PDF when saving (see -s) using a serial file
256263
NAMESFILE. The format of NAMESFILE should be as follows: each target PDF
257264
is an entry in NAMESFILE. For each entry, there should be a key {__save_morph_as__}
258-
whose value specifies the name to save the manipulated PDF as.
259-
(See sample names files in the PDFmorph tutorial).""",
265+
whose value specifies the name to save the manipulated PDF as. An example .json
266+
serial file is shown in the PDFmorph manual.""",
260267
)
261268
group.add_option(
262269
"--plot-parameter",
263270
metavar="PLOTPARAM",
264271
dest="plotparam",
265272
help="""Used when both plotting and --multiple are enabled.
266-
Choose a PLOTPARAM to plot for each morph (i.e. adding --pp=Pearson means the program
267-
will display a plot of the Pearson correlation coefficient for each morph-target pair).
268-
PLOTPARAM is not case sensitive, so both Pearson and pearson indicate the same parameter.
269-
When PLOTPARAM is not specified, Rw values for each morph-target pair will be plotted.
270-
PLOTPARAM will be displayed as the vertical axis label for the plot.""",
273+
Choose a PLOTPARAM to plot for each morph (i.e. adding --plot-parameter=Pearson means the
274+
program will display a plot of the Pearson correlation coefficient for each morph-target
275+
pair). PLOTPARAM is not case sensitive, so both Pearson and pearson indicate the same
276+
parameter. When PLOTPARAM is not specified, Rw values for each morph-target pair will be
277+
plotted. PLOTPARAM will be displayed as the vertical axis label for the plot.""",
271278
)
272279

273280
# Defaults

0 commit comments

Comments
 (0)