diff --git a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/CreateCalFileByNames.h b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/CreateCalFileByNames.h index f9ab49fbb54c..173b82956d7f 100644 --- a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/CreateCalFileByNames.h +++ b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/CreateCalFileByNames.h @@ -63,7 +63,7 @@ class DLLExport CreateCalFileByNames : public API::Algorithm /// Algorithm's name virtual const std::string name() const { return "CreateCalFileByNames"; } ///Summary of algorithms purpose - virtual const std::string summary() const {return "Create a calibration file (extension *.cal) for diffraction focusing based on the names of the components in the instrument tree.";} + virtual const std::string summary() const {return "Create a calibration file (extension .cal) for diffraction focusing based on the names of the components in the instrument tree.";} /// Algorithm's version virtual int version() const { return (1); } diff --git a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/CreateDummyCalFile.h b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/CreateDummyCalFile.h index da21549a8420..e44ded0a1122 100644 --- a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/CreateDummyCalFile.h +++ b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/CreateDummyCalFile.h @@ -59,7 +59,7 @@ class DLLExport CreateDummyCalFile : public API::Algorithm /// Algorithm's name virtual const std::string name() const { return "CreateDummyCalFile"; } ///Summary of algorithms purpose - virtual const std::string summary() const {return "Create a calibration file (extension *.cal) from a workspace by harvesting the detector ids from the instrument. All of the offsets will be zero, and the pixels will be all grouped into group one and the final column should be one. This will allow generating powder patterns from instruments that have not done a proper calibration.";} + virtual const std::string summary() const {return "Create a calibration file (extension .cal) from a workspace by harvesting the detector ids from the instrument. All of the offsets will be zero, and the pixels will be all grouped into group one and the final column should be one. This will allow generating powder patterns from instruments that have not done a proper calibration.";} /// Algorithm's version virtual int version() const { return (1); } diff --git a/Code/Mantid/Framework/Algorithms/src/MaskDetectorsIf.cpp b/Code/Mantid/Framework/Algorithms/src/MaskDetectorsIf.cpp index 614906f73ea5..8e2f1315a41b 100644 --- a/Code/Mantid/Framework/Algorithms/src/MaskDetectorsIf.cpp +++ b/Code/Mantid/Framework/Algorithms/src/MaskDetectorsIf.cpp @@ -53,9 +53,9 @@ void MaskDetectorsIf::init() "Unary operator to compare to given values. " + allowedValuesStatement(select_operator) ); declareProperty("Value",0.0); declareProperty(new API::FileProperty("InputCalFile","", API::FileProperty::Load, ".cal"), - "The name of the CalFile with grouping data. Allowed Values: *.cal ." ); + "The name of the CalFile with grouping data. Allowed Values: .cal ." ); declareProperty(new API::FileProperty("OutputCalFile","", API::FileProperty::OptionalSave, ".cal"), - "The name of the CalFile with grouping data. Allowed Values: *.cal ." ); + "The name of the CalFile with grouping data. Allowed Values: .cal ." ); } /** Executes the algorithm diff --git a/Code/Mantid/Framework/Algorithms/src/SumSpectra.cpp b/Code/Mantid/Framework/Algorithms/src/SumSpectra.cpp index 85b2030a53b7..c744e21ee1a8 100644 --- a/Code/Mantid/Framework/Algorithms/src/SumSpectra.cpp +++ b/Code/Mantid/Framework/Algorithms/src/SumSpectra.cpp @@ -47,8 +47,8 @@ void SumSpectra::init() declareProperty("IncludeMonitors",true,"Whether to include monitor spectra in the summation."); declareProperty("WeightedSum",false,"Instead of the usual spectra sum, calculate the weighted sum. This has the form: \n" - "nSpectra*\\Sigma(Signal_i/Error_i^2)/\\Sigma(1/Error_i^2)\n This property is ignored for event workspace.\n" - "The sums are defined for Error_i != 0 only, so the values with zero error are dropped from the summation. To estimate the number of dropped values see the description. "); + ":math:`nSpectra \\times\\Sigma(Signal_i/Error_i^2)/\\Sigma(1/Error_i^2)`\n This property is ignored for event workspace.\n" + "The sums are defined for :math:`Error_i != 0` only, so the values with zero error are dropped from the summation. To estimate the number of dropped values see the description. "); } /** Executes the algorithm diff --git a/Code/Mantid/Framework/Crystal/src/IntegratePeakTimeSlices.cpp b/Code/Mantid/Framework/Crystal/src/IntegratePeakTimeSlices.cpp index 21fe4e2c7a4d..0b84eb9ca9ee 100644 --- a/Code/Mantid/Framework/Crystal/src/IntegratePeakTimeSlices.cpp +++ b/Code/Mantid/Framework/Crystal/src/IntegratePeakTimeSlices.cpp @@ -188,7 +188,7 @@ namespace Mantid declareProperty("PeakIndex", 0, "Index of peak in PeaksWorkspace to integrate"); - declareProperty("PeakQspan", .06, "Max magnitude of Q of Peak to Q of Peak Center, where |Q|=1/d"); + declareProperty("PeakQspan", .06, "Max magnitude of Q of Peak to Q of Peak Center, where mod(Q)=1/d"); declareProperty("CalculateVariances", true ,"Calc (co)variances given parameter values versus fit (co)Variances "); diff --git a/Code/Mantid/Framework/DataHandling/src/LoadPreNexusMonitors.cpp b/Code/Mantid/Framework/DataHandling/src/LoadPreNexusMonitors.cpp index 3fdee009eb78..614bc8603fb2 100644 --- a/Code/Mantid/Framework/DataHandling/src/LoadPreNexusMonitors.cpp +++ b/Code/Mantid/Framework/DataHandling/src/LoadPreNexusMonitors.cpp @@ -47,7 +47,7 @@ void LoadPreNexusMonitors::init() { // Filename for the runinfo file. declareProperty(new FileProperty(RUNINFO_FILENAME, "", FileProperty::Load, "_runinfo.xml"), - "The filename of the runinfo file for a particular run. Allowed Values are: *_runinfo.xml"); + "The filename of the runinfo file for a particular run. Allowed Values are: _runinfo.xml"); // The output workspace declareProperty(new WorkspaceProperty (WORKSPACE_OUT, "", Direction::Output), diff --git a/Code/Mantid/Framework/MDAlgorithms/inc/MantidMDAlgorithms/ConvertToMD.h b/Code/Mantid/Framework/MDAlgorithms/inc/MantidMDAlgorithms/ConvertToMD.h index f997f71b7e69..b17521b9ea11 100644 --- a/Code/Mantid/Framework/MDAlgorithms/inc/MantidMDAlgorithms/ConvertToMD.h +++ b/Code/Mantid/Framework/MDAlgorithms/inc/MantidMDAlgorithms/ConvertToMD.h @@ -58,7 +58,7 @@ namespace MDAlgorithms /// Algorithm's name for identification virtual const std::string name() const; ///Summary of algorithms purpose - virtual const std::string summary() const {return "Create a MDEventWorkspace with selected dimensions, e.g. the reciprocal space of momentums (Qx, Qy, Qz) or momentums modules |Q|, energy transfer dE if available and any other user specified log values which can be treated as dimensions.";} + virtual const std::string summary() const {return "Create a MDEventWorkspace with selected dimensions, e.g. the reciprocal space of momentums (Qx, Qy, Qz) or momentums modules mod(Q), energy transfer dE if available and any other user specified log values which can be treated as dimensions.";} /// Algorithm's version for identification virtual int version() const; diff --git a/Code/Mantid/Framework/MDAlgorithms/src/ConvertToDiffractionMDWorkspace.cpp b/Code/Mantid/Framework/MDAlgorithms/src/ConvertToDiffractionMDWorkspace.cpp index 08555533f1cc..3a1931335f9d 100644 --- a/Code/Mantid/Framework/MDAlgorithms/src/ConvertToDiffractionMDWorkspace.cpp +++ b/Code/Mantid/Framework/MDAlgorithms/src/ConvertToDiffractionMDWorkspace.cpp @@ -97,7 +97,7 @@ namespace MDAlgorithms declareProperty( new PropertyWithValue("MinRecursionDepth", 0), "Optional. If specified, then all the boxes will be split to this minimum recursion depth. 1 = one level of splitting, etc.\n" - "Be careful using this since it can quickly create a huge number of boxes = (SplitInto ^ (MinRercursionDepth * NumDimensions)).\n" + "Be careful using this since it can quickly create a huge number of boxes = (SplitInto ^ (MinRercursionDepth x NumDimensions)).\n" "But setting this property equal to MaxRecursionDepth property is necessary if one wants to generate multiple file based workspaces in order to merge them later\n"); setPropertyGroup("MinRecursionDepth", getBoxSettingsGroupName()); diff --git a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/FuryFitMultiple.py b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/FuryFitMultiple.py index 68c5fa00d195..e7c267cd12f4 100644 --- a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/FuryFitMultiple.py +++ b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/FuryFitMultiple.py @@ -10,7 +10,7 @@ def category(self): return "Workflow\\MIDAS;PythonAlgorithms" def summary(self): - return "Fits and *_iqt file generated by Fury using one of the specified functions." + return "Fits an \*\_iqt file generated by Fury using one of the specified functions." def PyInit(self): self.declareProperty(name="InputType", defaultValue="File",validator=StringListValidator(['File', 'Workspace']), diff --git a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/QLines.py b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/QLines.py index 935077d15b87..4441e27080d4 100644 --- a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/QLines.py +++ b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/QLines.py @@ -13,16 +13,16 @@ def summary(self): return "The program estimates the quasielastic components of each of the groups of spectra and requires the resolution file (.RES file) and optionally the normalisation file created by ResNorm." def PyInit(self): - self.declareProperty(name='InputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of data input - File (*.nxs) or Workspace') + self.declareProperty(name='InputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of data input - File (.nxs) or Workspace') self.declareProperty(name='Instrument',defaultValue='iris',validator=StringListValidator(['irs','iris','osi','osiris']), doc='Instrument') self.declareProperty(name='Analyser',defaultValue='graphite002',validator=StringListValidator(['graphite002','graphite004']), doc='Analyser & reflection') self.declareProperty(name='Program',defaultValue='QL',validator=StringListValidator(['QL','QSe']), doc='Name of program to run') self.declareProperty(name='SamNumber',defaultValue='',validator=StringMandatoryValidator(), doc='Sample run number') - self.declareProperty(name='ResInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of res input - File (*_res.nxs) or Workspace') + self.declareProperty(name='ResInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of res input - File (_res.nxs) or Workspace') self.declareProperty(name='ResType',defaultValue='Res',validator=StringListValidator(['Res','Data']), doc='Format of Resolution file') self.declareProperty(name='ResNumber',defaultValue='',validator=StringMandatoryValidator(), doc='Resolution run number') self.declareProperty(name='ResNorm',defaultValue=False, doc='Use ResNorm output file') - self.declareProperty(name='ResNormInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of ResNorm input - File (*_red.nxs) or Workspace') + self.declareProperty(name='ResNormInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of ResNorm input - File (_red.nxs) or Workspace') self.declareProperty(name='ResNormNumber',defaultValue='', doc='ResNorm run number') self.declareProperty(name='BackgroundOption',defaultValue='Sloping',validator=StringListValidator(['Sloping','Flat','Zero']), doc='Form of background to fit') self.declareProperty(name='ElasticOption',defaultValue=True, doc='Include elastic peak in fit') diff --git a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/Quest.py b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/Quest.py index 00a43ec9bf66..a1a27c630064 100644 --- a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/Quest.py +++ b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/Quest.py @@ -13,13 +13,13 @@ def summary(self): return "This is a variation of the stretched exponential option of Quasi." def PyInit(self): - self.declareProperty(name='InputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of data input - File (*.nxs) or Workspace') + self.declareProperty(name='InputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of data input - File (.nxs) or Workspace') self.declareProperty(name='Instrument',defaultValue='iris',validator=StringListValidator(['irs','iris','osi','osiris']), doc='Instrument') self.declareProperty(name='Analyser',defaultValue='graphite002',validator=StringListValidator(['graphite002','graphite004']), doc='Analyser & reflection') self.declareProperty(name='SamNumber',defaultValue='',validator=StringMandatoryValidator(), doc='Sample run number') - self.declareProperty(name='ResInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of res input - File (*_res.nxs) or Workspace') + self.declareProperty(name='ResInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of res input - File (_res.nxs) or Workspace') self.declareProperty(name='ResNumber',defaultValue='',validator=StringMandatoryValidator(), doc='Resolution run number') - self.declareProperty(name='ResNormInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of ResNorm input - File (*_red.nxs) or Workspace') + self.declareProperty(name='ResNormInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of ResNorm input - File (_red.nxs) or Workspace') self.declareProperty(name='ResNormNumber',defaultValue='',validator=StringMandatoryValidator(), doc='ResNorm run number') self.declareProperty(name='ElasticOption',defaultValue=True, doc='Include elastic peak in fit') self.declareProperty(name='BackgroundOption',defaultValue='Sloping',validator=StringListValidator(['Sloping','Flat','Zero']), doc='Form of background to fit') diff --git a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ResNorm.py b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ResNorm.py index 9c1f229fde07..88268bf952c1 100644 --- a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ResNorm.py +++ b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ResNorm.py @@ -13,11 +13,11 @@ def summary(self): return "This algorithm creates a group 'normalisation' file by taking a resolution file and fitting it to all the groups in the resolution (vanadium) data file which has the same grouping as the sample data of interest." def PyInit(self): - self.declareProperty(name='InputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of data input - File (*.nxs) or Workspace') + self.declareProperty(name='InputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of data input - File (.nxs) or Workspace') self.declareProperty(name='Instrument',defaultValue='iris',validator=StringListValidator(['irs','iris','osi','osiris']), doc='Instrument') self.declareProperty(name='Analyser',defaultValue='graphite002',validator=StringListValidator(['graphite002','graphite004']), doc='Analyser & reflection') self.declareProperty(name='VanNumber',defaultValue='',validator=StringMandatoryValidator(), doc='Sample run number') - self.declareProperty(name='ResInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of res input - File (*_res.nxs) or Workspace') + self.declareProperty(name='ResInputType',defaultValue='File',validator=StringListValidator(['File','Workspace']), doc='Origin of res input - File (_res.nxs) or Workspace') self.declareProperty(name='ResNumber',defaultValue='',validator=StringMandatoryValidator(), doc='Resolution run number') self.declareProperty(name='EnergyMin', defaultValue=-0.2, doc='Minimum energy for fit. Default=-0.2') self.declareProperty(name='EnergyMax', defaultValue=0.2, doc='Maximum energy for fit. Default=0.2') diff --git a/Code/Mantid/Framework/SINQ/src/PoldiFitPeaks1D.cpp b/Code/Mantid/Framework/SINQ/src/PoldiFitPeaks1D.cpp index b5b6df7ae575..88391cc32c0a 100644 --- a/Code/Mantid/Framework/SINQ/src/PoldiFitPeaks1D.cpp +++ b/Code/Mantid/Framework/SINQ/src/PoldiFitPeaks1D.cpp @@ -61,7 +61,7 @@ void PoldiFitPeaks1D::init() declareProperty(new WorkspaceProperty("InputWorkspace","",Direction::Input), "An input workspace containing a POLDI auto-correlation spectrum."); boost::shared_ptr > minFwhmPerDirection = boost::make_shared >(); minFwhmPerDirection->setLower(2.0); - declareProperty("FwhmMultiples", 2.0, minFwhmPerDirection, "Each peak will be fitted using x * FWHM data in each direction.", Direction::Input); + declareProperty("FwhmMultiples", 2.0, minFwhmPerDirection, "Each peak will be fitted using x times FWHM data in each direction.", Direction::Input); std::vector peakFunctions = FunctionFactory::Instance().getFunctionNames(); boost::shared_ptr > peakFunctionNames(new ListValidator(peakFunctions));