From 0cff8a607382d2d688dbf4eafbed312c996430f0 Mon Sep 17 00:00:00 2001
From: Harriet Brown <harriet.brown@stfc.ac.uk>
Date: Thu, 20 Feb 2020 08:57:44 +0000
Subject: [PATCH] Apply changes from code review
This commit makes changes given from code review,
- Moved Engineering diffraction 2 gui test doc into it's own directory.
- corrected typographical errors.
---
.../EngineeringDiffraction2TestGuide.rst} | 12 ++++++------
dev-docs/source/Testing/index.rst | 2 +-
2 files changed, 7 insertions(+), 7 deletions(-)
rename dev-docs/source/Testing/{Engineering Diffraction 2 Test Guide.rst => EngineeringDiffraction/EngineeringDiffraction2TestGuide.rst} (86%)
diff --git a/dev-docs/source/Testing/Engineering Diffraction 2 Test Guide.rst b/dev-docs/source/Testing/EngineeringDiffraction/EngineeringDiffraction2TestGuide.rst
similarity index 86%
rename from dev-docs/source/Testing/Engineering Diffraction 2 Test Guide.rst
rename to dev-docs/source/Testing/EngineeringDiffraction/EngineeringDiffraction2TestGuide.rst
index 6cdd77172c1..2f53943d636 100644
--- a/dev-docs/source/Testing/Engineering Diffraction 2 Test Guide.rst
+++ b/dev-docs/source/Testing/EngineeringDiffraction/EngineeringDiffraction2TestGuide.rst
@@ -11,18 +11,18 @@ Preamble
This document is tailored towards developers intending to test the Engineering Diffraction
interface 2.
-Runs can also be loaded from the archive, however it is possible that different run numbers
+Runs can be loaded from the archive, however it is possible that different run numbers
will be needed as older runs may be deleted.
Overview
^^^^^^^^
The Engineering Diffraction 2 interface allows scientists using the EnginX instrument to interactively
-process their data. There are 3 tabs from which are ordered according to the main steps performed.
+process their data. There are 3 tabs which are ordered according to the main steps performed.
These are:
-- Calibration - This is where a vanadium and cerium run are entered to calibrate the subsequent data.
+- Calibration - This is where a vanadium and cerium oxide run are entered to calibrate the subsequent data.
- Focus - Where are the data across multiple spectra are summed into a single spectrum for later steps.
-- Fitting - Currently a work in progress
+- Fitting - Currently a work in progress, no testing is required
Test 1
^^^^^^
@@ -107,8 +107,8 @@ This test covers the Cropping ability
3. Click calibrate.
-4. Go to focus tab and to the same with the Crop Focus.
+4. Go to focus tab and do the same with the Crop Focus.
5. Change the RB number to custom.
-6. repeat steps 2-4 this time using Custom Spectra `1200-1400`
\ No newline at end of file
+6. Repeat steps 2-4 this time using Custom Spectra `1200-1400`
\ No newline at end of file
diff --git a/dev-docs/source/Testing/index.rst b/dev-docs/source/Testing/index.rst
index 4e6eb6884a5..c1384c60fbc 100644
--- a/dev-docs/source/Testing/index.rst
+++ b/dev-docs/source/Testing/index.rst
@@ -23,7 +23,7 @@ creation is outlined in :ref:`issue_tracking`.
MuonAnalysis_test_guides/index
MuonInterface/MuonTesting
IndirectInelastic/IndirectInelasticAcceptanceTests
- Engineering Diffraction Test 2 Guide
+ EngineeringDiffraction/EngineeringDiffraction2TestGuide
ErrorReporter-ProjectRecovery/ErrorReporterTesting
ErrorReporter-ProjectRecovery/ProjectRecoveryTesting
LiveData/LiveDataTests
--
GitLab