Add the Returns section to the operator automatic docstring (#1823)

* Add the Returns section to the operator automatic docstring

Signed-off-by: paul.profizi <[email protected]>

* update generated code (#1824)

Co-authored-by: PProfizi <[email protected]>

---------

Signed-off-by: paul.profizi <[email protected]>
Co-authored-by: PyAnsys CI Bot <[email protected]>
Co-authored-by: PProfizi <[email protected]>

Author: PProfizi

src/ansys/dpf/core/operators/averaging/elemental_difference.py

@@ -30,6 +30,9 @@ class elemental_difference(Operator):
         through the different shell layers if
         true (default is false).
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py

@@ -38,6 +38,9 @@ class elemental_difference_fc(Operator):
         through the different shell layers if
         true (default is false).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py

@@ -40,6 +40,9 @@ class elemental_fraction_fc(Operator):
         different shell layers if true
         (default is false).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

src/ansys/dpf/core/operators/averaging/elemental_mean.py

@@ -29,6 +29,9 @@ class elemental_mean(Operator):
         correspond to the one of the fields
         containers.
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py

@@ -36,6 +36,9 @@ class elemental_mean_fc(Operator):
         perform the averaging. it is used if
         there is no fields support.
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal.py

@@ -36,6 +36,13 @@ class elemental_nodal_to_nodal(Operator):
         available). default is false.
     mesh : MeshedRegion, optional
 
+    Returns
+    -------
+    field : Field
+    weight : PropertyField
+        Provides the number of times it was found in
+        the elemental nodal field, for each
+        node. can be used to average later.
 
     Examples
     --------

src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental.py

@@ -22,6 +22,9 @@ class elemental_nodal_to_nodal_elemental(Operator):
         is expected
     mesh_scoping : Scoping, optional
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental_fc.py

@@ -20,6 +20,9 @@ class elemental_nodal_to_nodal_elemental_fc(Operator):
     fields_container : FieldsContainer
     mesh_scoping : Scoping, optional
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py

@@ -52,6 +52,14 @@ class elemental_nodal_to_nodal_fc(Operator):
         one field all solids and shells (only
         on one layer).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
+    weights : Class Dataprocessing::Dpftypecollection<Class
+        Dataprocessing::Cpropertyfield>
+        Gives for each node, the number of times it
+        was found in the elemental nodal
+        field. can be used to average later.
 
     Examples
     --------

src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal.py

@@ -23,6 +23,9 @@ class elemental_to_elemental_nodal(Operator):
         Average only on these entities
     mesh : MeshedRegion, optional
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------