Skip to content

Commit

Permalink
Refs #10020. Tweak wording of documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Harry Jeffery committed Aug 4, 2014
1 parent 3d56705 commit 82db0df
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Expand Up @@ -36,7 +36,7 @@ namespace Algorithms
const std::string ClearInstrumentParameters::name() const { return "ClearInstrumentParameters";};

/// Summary of the algorithm's purpose. @see Algorithm::summary
const std::string ClearInstrumentParameters::summary() const { return "Clears all the parameters of a workspace's instrument.";}
const std::string ClearInstrumentParameters::summary() const { return "Clears all the parameters associated with a workspace's instrument.";}

/// Algorithm's version for identification. @see Algorithm::version
int ClearInstrumentParameters::version() const { return 1;};
Expand Down
Expand Up @@ -15,7 +15,7 @@ Parameters are used by Mantid to tweak an instrument's values without having to
the `instrument definition file <http://mantidproject.org/InstrumentDefinitionFile>`__ itself.

The LocationParameters property specifies whether or not to clear any calibration parameters
used to adjust the location of any components. Specifically, it will not clear the "x", "y", "z",
used to adjust the location of any components. Specifically, it will clear the "x", "y", "z",
"r-position", "t-position", "p-position", "rotx", "roty", and "rotz" parameters.

.. categories::

0 comments on commit 82db0df

Please sign in to comment.