diff --git a/docs/source/algorithms/Comment-v1.rst b/docs/source/algorithms/Comment-v1.rst index db25302c889abb13ed459bc1a5c6ed580f12b571..ee89fdfac9ccd503f9848abd8c739451f5c135d0 100644 --- a/docs/source/algorithms/Comment-v1.rst +++ b/docs/source/algorithms/Comment-v1.rst @@ -14,6 +14,8 @@ This simple algorithm just adds a comment record to the history of a workspace a It does not change the data within a workspace in any way. +When outputing the histroy to Python this comment will be rendered as a python comment. + Usage ----- @@ -38,4 +40,4 @@ Output: .. categories:: .. sourcelink:: - + :h: Framework/Algorithms/inc/MantidAlgorithms/Comment.h