Ticket #2572 (closed: fixed)

Opened 10 years ago

Last modified 5 years ago

Add optional message to algorithms where it is not set

Reported by: Janik Zikovsky Owned by: Janik Zikovsky
Priority: major Milestone: Iteration 28
Component: Mantid Keywords:
Cc: Blocked By:
Blocking: Tester: Andrei Savici

Description

... make a script to scrape it out of the wiki: 

http://www.mantidproject.org/index.php?title=AlignDetectors&action=raw&section=1

Change History

comment:1 Changed 10 years ago by Janik Zikovsky

  • Status changed from new to accepted

comment:2 Changed 10 years ago by Janik Zikovsky

List of algorithms with some issue: 

LoadISISNexus2 ------> WIKI SUMMARY NOT FOUND
LoadSNSEventNexus ------> WIKI SUMMARY NOT FOUND
LoadMuonNexus2 ------> WIKI SUMMARY NOT FOUND
LoadISISNexus ------> WIKI SUMMARY NOT FOUND
SaveSNSNexus ------> Optional message already set for SaveSNSNexus
LoadLogsFromSNSNexus ------> Optional message already set for LoadLogsFromSNSNexus
LoadEventNexus ------> Optional message already set for LoadEventNexus
Lorentzian1D ------> Could not find init()
UserFunction1D ------> Could not find init()
Gaussian1D ------> Could not find init()
GaussianLinearBG1D ------> WIKI SUMMARY NOT FOUND
CreateMDEventWorkspace ------> WIKI SUMMARY NOT FOUND
MakeDiffractionMDEventWorkspace ------> WIKI SUMMARY NOT FOUND
CGetDataSets ------> WIKI SUMMARY NOT FOUND
CSearch ------> WIKI SUMMARY NOT FOUND
CDownloadDataFile ------> WIKI SUMMARY NOT FOUND
CLogout ------> WIKI SUMMARY NOT FOUND
CListInstruments ------> WIKI SUMMARY NOT FOUND
CMyDataSearch ------> WIKI SUMMARY NOT FOUND
Login ------> WIKI SUMMARY NOT FOUND
CGetDataFiles ------> WIKI SUMMARY NOT FOUND
CListInvestigationTypes ------> WIKI SUMMARY NOT FOUND
CenterpieceRebinning ------> WIKI SUMMARY NOT FOUND
Load_MDWorkspace ------> WIKI SUMMARY NOT FOUND
DynamicRebinFromXML ------> WIKI SUMMARY NOT FOUND
SimulateMDD ------> WIKI SUMMARY NOT FOUND
CuboidGaugeVolumeAbsorption ------> Could not find init()
StripVanadiumPeaks ------> Optional message already set for StripVanadiumPeaks
Rebin ------> Optional message already set for Rebin
FindDetectorsOutsideLimits ------> Optional message already set for FindDetectorsOutsideLimits
Multiply ------> Could not find init()
FFTDerivative ------> WIKI SUMMARY NOT FOUND
Plus ------> Could not find init()
Divide ------> Could not find init()
ConjoinWorkspaces ------> Optional message already set for ConjoinWorkspaces
ExponentialCorrection ------> Could not find init()
PowerLawCorrection ------> Could not find init()
ConvertToPointData ------> Could not find init()
PoissonErrors ------> Could not find init()
DiffractionFocussing2 ------> WIKI SUMMARY NOT FOUND
DeleteWorkspace ------> Optional message already set for DeleteWorkspace
ConvertToHistogram ------> Could not find init()
FlatPlateAbsorption ------> Could not find init()
Power ------> Could not find init()
PolynomialCorrection ------> Could not find init()
ConvertToMatrixWorkspace ------> Optional message already set for ConvertToMatrixWorkspace
ChopData ------> WIKI SUMMARY NOT FOUND
MaskBins ------> Optional message already set for MaskBins
AnyShapeAbsorption ------> WIKI SUMMARY NOT FOUND
OneMinusExponentialCor ------> Could not find init()
Transpose ------> Could not find init()
TofCorrection ------> Could not find init()
IdentifyNoisyDetectors ------> Could not find init()
ExtractFFTSpectrum ------> Could not find init()
SpatialGrouping ------> Could not find init()
CreateWorkspace ------> Optional message already set for CreateWorkspace
CreateWorkspace ------> Could not find init()
Minus ------> Could not find init()
SingleCrystalTOFIntegration ------> WIKI SUMMARY NOT FOUND
GetEi2 ------> WIKI SUMMARY NOT FOUND
FilterByTime ------> Optional message already set for FilterByTime
CylinderAbsorption ------> Could not find init()
MultipleScatteringAbsorption ------> WIKI SUMMARY NOT FOUND
MergeRuns ------> Optional message already set for MergeRuns
Logarithm ------> WIKI SUMMARY NOT FOUND
AlignDetectors ------> Optional message already set for AlignDetectors
FindCenterOfMassPosition2 ------> WIKI SUMMARY NOT FOUND
ElasticWindow ------> Could not find init()
MuonRemoveExpDecay ------> WIKI SUMMARY NOT FOUND
SumNeighbours ------> Optional message already set for SumNeighbours
Exponential ------> Could not find init()
FFTSmooth2 ------> WIKI SUMMARY NOT FOUND
FilterByLogValue ------> Optional message already set for FilterByLogValue
ReplaceSpecialValues ------> Could not find init()
Max ------> WIKI SUMMARY NOT FOUND
WeightedMean ------> Could not find init()
DspacemaptoCal ------> Optional message already set for DspacemaptoCal
MonteCarloAbsorption ------> WIKI SUMMARY NOT FOUND
FilterBadPulses ------> Optional message already set for FilterBadPulses
PropertyAlgorithm ------> WIKI SUMMARY NOT FOUND
ModifyData ------> WIKI SUMMARY NOT FOUND
WorkspaceAlgorithm ------> WIKI SUMMARY NOT FOUND
HelloWorldAlgorithm ------> WIKI SUMMARY NOT FOUND
GroupDetectors2 ------> WIKI SUMMARY NOT FOUND
LoadRaw3 ------> WIKI SUMMARY NOT FOUND
LoadRaw2 ------> WIKI SUMMARY NOT FOUND
LoadDaveGrp ------> WIKI SUMMARY NOT FOUND
LoadDetectorInfo ------> Optional message already set for LoadDetectorInfo

comment:3 Changed 10 years ago by Janik Zikovsky

(In [9750]) Refs #2572: script to set optional message.

comment:4 Changed 10 years ago by Janik Zikovsky

(In [9751]) Refs #2572: Added a setOptionalMessage() call to a lot of algorithms.

comment:5 Changed 10 years ago by Janik Zikovsky

(In [9752]) Refs #2572: Remove word wrapping from Load dialog since it made funky resizing effects.

comment:6 Changed 10 years ago by Janik Zikovsky

(In [9753]) Refs #2572: Ran into issue with un-escaped characters that my compiler did not catch. Commented out all optional messages until I can fix it.

comment:7 Changed 10 years ago by Janik Zikovsky

(In [9754]) Refs #2572: Fixing up a couple of optional messages.

comment:8 Changed 10 years ago by Janik Zikovsky

Last few ones missing WIKIs: 

LoadISISNexus2 ------> WIKI SUMMARY NOT FOUND at  LoadISISNexus
LoadSNSEventNexus ------> WIKI SUMMARY NOT FOUND at  LoadSNSEventNexus
LoadISISNexus ------> WIKI SUMMARY NOT FOUND at  LoadISISNexus
CenterpieceRebinning ------> WIKI SUMMARY NOT FOUND at  CenterpieceRebinning
Load_MDWorkspace ------> WIKI SUMMARY NOT FOUND at  LoadMDworkspace
DynamicRebinFromXML ------> WIKI SUMMARY NOT FOUND at  DynamicRebinFromXML
SimulateMDD ------> WIKI SUMMARY NOT FOUND at  SimulateMDD
FFTDerivative ------> WIKI SUMMARY NOT FOUND at  FFTDerivative
ChopData ------> WIKI SUMMARY NOT FOUND at  ChopData
SingleCrystalTOFIntegration ------> WIKI SUMMARY NOT FOUND at  SingleCrystalTOFIntegration
MultipleScatteringAbsorption ------> WIKI SUMMARY NOT FOUND at  MultipleScatteringAbsorption
Logarithm ------> WIKI SUMMARY NOT FOUND at  Logarithm
Max ------> WIKI SUMMARY NOT FOUND at  Max
MonteCarloAbsorption ------> WIKI SUMMARY NOT FOUND at  MonteCarloAbsorption
PropertyAlgorithm ------> WIKI SUMMARY NOT FOUND at  PropertyAlgorithm
ModifyData ------> WIKI SUMMARY NOT FOUND at  ModifyData
WorkspaceAlgorithm ------> WIKI SUMMARY NOT FOUND at  WorkspaceAlgorithm
HelloWorldAlgorithm ------> WIKI SUMMARY NOT FOUND at  HelloWorldAlgorithm
LoadDaveGrp ------> WIKI SUMMARY NOT FOUND at  LoadDaveGrp

comment:9 Changed 10 years ago by Janik Zikovsky

(In [9771]) Refs #2572.

comment:10 Changed 10 years ago by Janik Zikovsky

(In [9773]) Refs #2572.

comment:11 Changed 10 years ago by Janik Zikovsky

(In [9776]) Refs #2572: Added an initDocs() for all algorithms that sets the summary string to display in the dialog, as well as the wiki summary for possible later auto-wiki-fication of documentation.

comment:12 Changed 10 years ago by Janik Zikovsky

  • Status changed from accepted to verify
  • Resolution set to fixed

comment:13 Changed 9 years ago by Andrei Savici

  • Status changed from verify to verifying
  • Tester set to Andrei Savici

comment:14 Changed 9 years ago by Andrei Savici

  • Status changed from verifying to closed

comment:15 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​3419

Note: See TracTickets for help on using tickets.