Skip to content
Snippets Groups Projects
Commit 6bfd0aeb authored by NickDraper's avatar NickDraper
Browse files

Add note about rendering as a python comment and add sourcelink option re #13867

parent 4bcf3200
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
docs/source/algorithms/Comment-v1.rst
+ 3
− 1
View file @ 6bfd0aeb
...@@ -14,6 +14,8 @@ This simple algorithm just adds a comment record to the history of a workspace a ...@@ -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. 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 Usage
----- -----
...@@ -38,4 +40,4 @@ Output: ...@@ -38,4 +40,4 @@ Output:
.. categories:: .. categories::
.. sourcelink:: .. sourcelink::
:h: Framework/Algorithms/inc/MantidAlgorithms/Comment.h
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment