Review interface documentation

[raquelalvarezbanos]

This is the current status regarding interface documentation (OK means that the interface as an .rst file and that there's a help button/menu linking to it):

Diffraction:

• Engineering diffraction: OK
• HFIR 4-Circle Reduction: has an .rst file although I can’t find a help button linking to it
• HFIR Powder Reduction: OK
• Powder Diffraction Reduction (NOM Reduction): has a help button but it only shows a brief message. I haven’t found a wiki page for the interface.
• SCD Event Data Reduction: has an .rst file but help button links to old wiki page which was deleted.
• Tomographic reconstruction: OK

Direct:

• “Convert to energy transfer”: has documentation in wiki page (http://www.mantidproject.org/Homer) that could be moved to .rst file
• “DGS Reduction”: No help button, I think this: http://www.mantidproject.org/Direct:DgsReduction is the corresponding wiki page.
• “DGS Planner”: Can’t run the interface, it seems that I need to have Td installed.

DynamicPDF:

• Dynamic PDF Background remover: OK
• Test Display CurveFit: not sure if this is even an interface? Or just part of the interface above. In any case it does not have .rst associated.

General:

• Data Comparison: has an .rst but no help button linking to it.
• MultiDataset fitting: no help button, couldn’t find .rst file but maybe it’s still under development?
• Sample Transmission Calculator: OK
• Step Scan Analysis: has wiki page: http://www.mantidproject.org/Step_Scan_Interface that could be moved to .rst file

Indirect:

• Bayes: OK
• Corrections: OK
• Data Analysis: OK
• Data Reduction: OK
• Diffraction: OK
• Simulation: OK
• Tools: OK

Muon:

• ALC: OK
• Muon Analysis: there an open issue to fix this.

Reflectometry:

• ISIS Reflectometry: has wiki page: http://www.mantidproject.org/ISIS_Reflectometry_GUI
• ISIS Reflecomtetry (Polref): OK
• REFLSF Reduction: does not have help button, does not have .rst file, and I couldn’t find a wiki page for it
• REFM Reduction: does not have help button, does not have .rst file, and I couldn’t find a wiki page for it

SANS:

• ISIS SANS: has a wiki page: http://www.mantidproject.org/Using_the_SANS_GUI and then different wiki pages for each tab (http://www.mantidproject.org/ISIS_SANS:_Run_Numbers etc) that could be moved to .rst file
• EQSANS Reduction: does not have help button (it does have one but just shows a brief message), does not have .rst file and I can’t find a wiki page for the interface (there’s however a wiki page explaining the reduction)

Utility:

• Filter events: OK
• QECoverage: OK
• TOF Converter: OK

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you feel this is incorrect please comment to keep it alive, with a reason why.

To prevent closure, e.g. for long-term planning issues, add the "Never Stale" label.

[stale[bot]]

This issue has been closed automatically. If this still affects you please re-open this issue with a comment so we can look into resolving it.