From 3b7353ebfb3a9368d2e905bfdf1300b2b9d44f17 Mon Sep 17 00:00:00 2001
From: Shahroz Ahmed <shahroz.ahmed@stfc.ac.uk>
Date: Fri, 19 Aug 2016 12:05:47 +0100
Subject: [PATCH] release notes and documentation updated
refs #17274
---
.../interfaces/Engineering_Diffraction.rst | 16 +++++++++-------
docs/source/release/v3.8.0/diffraction.rst | 4 ++++
2 files changed, 13 insertions(+), 7 deletions(-)
diff --git a/docs/source/interfaces/Engineering_Diffraction.rst b/docs/source/interfaces/Engineering_Diffraction.rst
index b521317f3cf..a3d34483279 100644
--- a/docs/source/interfaces/Engineering_Diffraction.rst
+++ b/docs/source/interfaces/Engineering_Diffraction.rst
@@ -341,12 +341,14 @@ providing a list of dSpacing values where Bragg peaks are expected.
The algorithm :ref:`EnggFitPeaks<algm-EnggFitPeaks>` is used to
background fit peaks in those areas using a peak fitting function.
-To use the Fitting tab, user is required to provide:
+To use the Fitting tab, user is required to follow these steps:
1. A focused file as Focus Run input by browsing or entering single/multi
- run number
-2. List of expected peaks which can be either by browsing a (*CSV*) file
- or entering within the text-field
+ run number, *User may click Load button to load the focused file to the
+ canvas*
+2. List of expected peaks which can be either by browsing a (*CSV*) file,
+ manually selecting peaks from the canvas using peak picker tool after
+ loading the focused file or by entering the peaks list within the text-field
3. Next click on the *Fit* button if you would like to fit single focused
file or you can click *Fit All* button which will enable user to
batch-process all the runs and banks when a range of run number is given,
@@ -437,9 +439,9 @@ Preview
^^^^^^^
Once the fitting process has completed and you are able to view a
focused workspace with listed expected peaks on the data plot, the *Select
-Peak* button should also be enabled. If the fitting fails with
-the given peaks then the focused workspace will still be plotted so
-that user can select peaks manually.
+Peak* button should also be enabled. If the user choose to load the focus
+workspace or if fitting fails with the given peaks then the focused
+workspace will be plotted so that the user can select the peaks manually.
By clicking Select Peak button the peak picker tool can be activated.
To select a peak simply hold *Shift* key and left-click on the graph
diff --git a/docs/source/release/v3.8.0/diffraction.rst b/docs/source/release/v3.8.0/diffraction.rst
index 682943f5448..b6f63c10659 100644
--- a/docs/source/release/v3.8.0/diffraction.rst
+++ b/docs/source/release/v3.8.0/diffraction.rst
@@ -52,6 +52,10 @@ Engineering Diffraction
will be utilised to save *engggui_fitting_fitpeaks_param*
TableWorkspace as a `csv` file.
+- New *Load* button on the Fitting Tab, will enable user to load the
+ focused file to the canvas, so that the user can select the peaks
+ manually beforehand
+
Powder Diffraction
------------------
--
GitLab