From 6bfd0aebd7d479b0c7b4d7d49cff198879fc88e3 Mon Sep 17 00:00:00 2001
From: NickDraper <nick.draper@stfc.ac.uk>
Date: Mon, 26 Oct 2015 09:04:35 +0000
Subject: [PATCH] Add note about rendering as a python comment and add
 sourcelink option re #13867

---
 docs/source/algorithms/Comment-v1.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/source/algorithms/Comment-v1.rst b/docs/source/algorithms/Comment-v1.rst
index db25302c889..ee89fdfac9c 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
-- 
GitLab