#117: Update docstring for export

mesh-adaptation · Nov 1, 2024 · eb82642 · eb82642
1 parent 514af10
commit eb82642
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/goalie/function_data.py b/goalie/function_data.py
@@ -178,8 +178,9 @@ def export(self, output_fpath, export_field_types=None, initial_condition=None):
         :kwarg export_field_types: the field types to export; defaults to all available
             field types
         :type export_field_types: :class:`str` or :class:`list` of :class:`str`
-        :kwarg initial_condition: if provided, exports the initial condition. Only
-            supported when only the 'forward' field type is exported.
+        :kwarg initial_condition: if provided, exports the provided initial condition
+            for 'forward' fields. Initial values for other fields are set to 'nan' since
+            they are not defined at the initial time (e.g., 'adjoint' fields)
         :type initial_condition: :class:`dict` of :class:`~.Function`
         """
         if export_field_types is None: