Skip to content

doc(operators): remove links to undefined types in operator doc template #2523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PProfizi merged 4 commits into from
Aug 6, 2025
Merged

doc(operators): remove links to undefined types in operator doc template #2523

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ee36b9d
removed unused brackets in the operato_doc_template.md file
AnsMelanie Jul 18, 2025
2551af6
DPF operator doc: removed links for these strings: materials_containe…
AnsMelanie Aug 6, 2025
c4f5fe1
Delete doc/source/operators_doc/core-concepts/dpf-types.md
PProfizi Aug 6, 2025
434650a
Merge branch 'main' into AnsMelanie/op-doc/remove-links
PProfizi Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions doc/source/operators_doc/operator-specifications/operator_doc_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@
| Input | Name | Expected type(s) | Description |
|-------|-------|------------------|-------------|
{%- for input in inputs %}
| {% if not input.optional %}<strong>Pin {{ input.pin_number }}</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>{% else %}<strong>Pin {{ input.pin_number }}</strong>{% endif %}| {{ input.name }} |

Check warning on line 20 in doc/source/operators_doc/operator-specifications/operator_doc_template.md

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/operators_doc/operator-specifications/operator_doc_template.md#L20 

[Google.FirstPerson] Avoid first-person pronouns such as ' i '.
Raw output 
{"message": "[Google.FirstPerson] Avoid first-person pronouns such as ' i '.", "location": {"path": "doc/source/operators_doc/operator-specifications/operator_doc_template.md", "range": {"start": {"line": 20, "column": 1}}}, "severity": "WARNING"}
{%- for t in input.types -%}{% if "::" in t %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ input.document | replace("\n", "<br>") }} |
{%- for t in input.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap<int32,int32>" or t == "stream" or t == "vector<shared_ptr<any_collection>>" or t == "vector<shared_ptr<field>>" or t == "umap<string,shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<abstract_meshed_region>>" or t == "vector<shared_ptr<materials>>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector<shared_ptr<fields_container>>" or t == "vector<shared_ptr<data_tree>>" or t == "vector<shared_ptr<generic_data_container>>" or t == "vector<shared_ptr<time_freq_support>>" or t == "mesh_selection_manager" or t == "vector<shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<string_field>>" or t == "vector<shared_ptr<scopings_container>>" or t == "vector<shared_ptr<scoping>>" or t == "vector<shared_ptr<result_info>>" or t == "vector<shared_ptr<meshes_container>>"
%}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ input.document | replace("\n", "<br>") }} |
{%- endfor %}

## Outputs
Expand All @@ -27,7 +28,7 @@
|-------|------|------------------|-------------|
{%- for output in outputs %}
| **Pin {{ output.pin_number }}**| {{ output.name }} |
{%- for t in output.types -%}{% if "::" in t %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ output.document }} |
{%- for t in output.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap<int32,int32>" or t == "stream" or t == "vector<shared_ptr<any_collection>>" or t == "vector<shared_ptr<field>>" or t == "umap<string,shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<abstract_meshed_region>>" or t == "vector<shared_ptr<materials>>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector<shared_ptr<fields_container>>" or t == "vector<shared_ptr<data_tree>>" or t == "vector<shared_ptr<generic_data_container>>" or t == "vector<shared_ptr<time_freq_support>>" or t == "mesh_selection_manager" or t == "vector<shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<string_field>>" or t == "vector<shared_ptr<scopings_container>>" or t == "vector<shared_ptr<scoping>>" or t == "vector<shared_ptr<result_info>>" or t == "vector<shared_ptr<meshes_container>>" %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ output.document }} |
{%- endfor %}

## Configurations
Expand All @@ -36,7 +37,7 @@
|-----|------|----------|-------------|
{%- for configuration in configurations %}
| **{{ configuration.name }}** |
{%- for t in configuration.types -%}{% if "::" in t %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ configuration.default_value }} | {{ configuration.document }} |
{%- for t in configuration.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap<int32,int32>" or t == "stream" or t == "vector<shared_ptr<any_collection>>" or t == "vector<shared_ptr<field>>" or t == "umap<string,shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<abstract_meshed_region>>" or t == "vector<shared_ptr<materials>>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector<shared_ptr<fields_container>>" or t == "vector<shared_ptr<data_tree>>" or t == "vector<shared_ptr<generic_data_container>>" or t == "vector<shared_ptr<time_freq_support>>" or t == "mesh_selection_manager" or t == "vector<shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<string_field>>" or t == "vector<shared_ptr<scopings_container>>" or t == "vector<shared_ptr<scoping>>" or t == "vector<shared_ptr<result_info>>" or t == "vector<shared_ptr<meshes_container>>" %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ configuration.default_value }} | {{ configuration.document }} |
{%- endfor %}

## Scripting
Expand Down
Loading