Commit bd14e3d6 authored by Cory Quammen's avatar Cory Quammen Committed by Kitware Robot

Merge topic 'annotate-attribute-docs-fix'

c2d5842c Some fixes to docs for Python Annotation filter
3f013670 Some cleanup of documentation for Annotate Global Data filter
8fa8276b Fix a typo and copy pasta in the Annotate Attribute Data filter
Acked-by: Kitware Robot's avatarKitware Robot <kwrobot@kitware.com>
Acked-by: Utkarsh Ayachit's avatarUtkarsh Ayachit <utkarsh.ayachit@kitware.com>
Merge-request: !2956
parents bcf278c8 c2d5842c
Pipeline #127109 running with stage
......@@ -106,15 +106,15 @@ timestep.
name="Input" />
</RequiredProperties>
</ArrayListDomain>
<Documentation>Choose arrays that is going to be
displayed</Documentation>
<Documentation>Choose array that is going to be
displayed.</Documentation>
</StringVectorProperty>
<StringVectorProperty command="SetPrefix"
default_values="Value is: "
name="Prefix"
number_of_elements="1">
<Documentation>Text that is used as a prefix to the field
value</Documentation>
value.</Documentation>
</StringVectorProperty>
<StringVectorProperty command="SetFormat"
default_values="%7.5g"
......@@ -129,7 +129,7 @@ timestep.
name="Suffix"
number_of_elements="1">
<Documentation>Text that is used as a suffix to the field
value</Documentation>
value.</Documentation>
</StringVectorProperty>
<Hints>
<Visibility replace_input="0" />
......@@ -142,7 +142,7 @@ timestep.
<SourceProxy class="vtkAnnotateAttributeDataFilter"
label="Annotate Attribute Data"
name="AnnotateAttributeData">
<Documentation short_help="Adds a text annotation to a Rander View">
<Documentation short_help="Adds a text annotation to a Render View">
This filter can be used to add a text annotation to a Render View (or
similar) using a tuple from any attribute array (point/cell/field/row
etc.) from a specific rank (when running in parallel). Use **ArrayName**
......@@ -185,7 +185,7 @@ annotation text.
</RequiredProperties>
</ArrayListDomain>
<Documentation>This property indicates the name of the array from which
to compute the histogram.</Documentation>
to obtain the annotation value.</Documentation>
</StringVectorProperty>
<IntVectorProperty name="ElementId"
command="SetElementId"
......@@ -252,7 +252,7 @@ annotation text.
default_values="2"
name="ArrayAssociation"
number_of_elements="1">
<Documentation>Select the attribute to use to popular array names from.</Documentation>
<Documentation>Select the attribute to use to populate array names.</Documentation>
<EnumerationDomain name="enum">
<Entry text="Point Data" value="0" />
<Entry text="Cell Data" value="1" />
......@@ -264,7 +264,7 @@ annotation text.
name="Expression"
number_of_elements="1">
<Documentation>The Python expression evaluated during execution.
FieldData arrays are direclty available through their name. Set of
FieldData arrays are directly available through their name. Set of
provided variables [input, t_value, t_steps, t_range, t_index,
FieldData, PointData, CellData] (i.e.: "Momentum: (%f, %f, %f)" %
(XMOM[t_index,0], YMOM[t_index,0], ZMOM[t_index,0]) )</Documentation>
......
Markdown is supported
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