\(\renewcommand\AA{\unicode{x212B}}\)
Comment dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| Workspace | InOut | Workspace | Mandatory | An InOut workspace that will store the new history comment |
| Text | Input | string | Mandatory | The text you want to store in the history of the workspace |
This simple algorithm just adds a comment record to the history of a workspace and is a simple way of annotating your workflow.
It does not change the data within a workspace in any way.
When outputting the history to Python this comment will be rendered as a python comment.
Example - Comment
ws = CreateSampleWorkspace()
Comment(ws,"The next algorithm is doing 1/ws")
# Print the result
print(ws.getHistory().lastAlgorithm().getPropertyValue("Text"))
Output:
The next algorithm is doing 1/ws
Categories: AlgorithmIndex | Utility\Workspaces
C++ header: Comment.h (last modified: 2020-03-20)
C++ source: Comment.cpp (last modified: 2020-04-07)