Package diffpy :: Package srrietveld :: Package applications :: Module srhelp

Module srhelp

Functions

getHelp(optionname)
Get help string for an option name

source code

Variables
	__id__ = `'$Id: srhelp.py 5658 2010-07-09 20:05:34Z juhas $'`
	__package__ = `None`
	helpstring = `{'background': 'Name of Data File Containing Back...`

Function Details

getHelp(optionname)

source code

Get help string for an option name

Arguement:

optionname : str, name of an option supported

Return : str

Variables Details

helpstring

Value:

{'background': 'Name of Data File Containing Background Parameter or B
ackground XML file',
 'bank': 'Bank(s) to refine in T.O.F. data',
 'data': 'Full-path Name of Data File',
 'engine': 'Type of Refinement Engine (i.e.,Refinement Backend). Fullp
rof or GSAS',
 'excludedregion': 'Name of XML file to Indicate User Specified Exclud
ed Region',
...