Run doctests in fmudesign as part of GH actions

equinor · Nov 29, 2024 · 3df85c3 · 3df85c3
1 parent e946978
commit 3df85c3
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 18 deletions.
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -38,3 +38,6 @@ jobs:
 
       - name: "Run tests"
         run: pytest tests -n logical --durations 5 --ert-integration
+
+      - name: "Run doctests on fmudesign"
+        run: pytest .\src\semeio\fmudesign\ --doctest-modules -v
diff --git a/src/semeio/fmudesign/_designsummary.py b/src/semeio/fmudesign/_designsummary.py
@@ -32,11 +32,11 @@ def summarize_design(filename, sheetname="DesignSheet01"):
         'senstype', 'casename1', 'startreal1', 'endreal1',
         'casename2', 'startreal2', 'endreal2']
 
-    Example::
-        >>> from semeio.fmudesign import summarize_design
-        >>> designname = 'design_filename.xlsx'
-        >>> designsheet = 'DesignSheet01'
-        >>> designtable = summarize_design(designname, designsheet)
+    Example:
+        >> from semeio.fmudesign import summarize_design
+        >> designname = 'design_filename.xlsx'
+        >> designsheet = 'DesignSheet01'
+        >> designtable = summarize_design(designname, designsheet)
 
     """
 

diff --git a/src/semeio/fmudesign/_tornado_onebyone.py b/src/semeio/fmudesign/_tornado_onebyone.py
@@ -106,19 +106,19 @@ def calc_tornadoinput(
             * (int): Average response value for realizations in
                      reference sensitivity.
 
-    Example::
-        >>> import pandas as pd
-        >>> from semeio.fmudesign import calc_tornadoplot
-        >>> designtable = pd.read_csv('designsummary.csv')
-        >>> results = pd.read_csv('resultfile.csv')
-        >>> response = 'STOIIP_OIL'
-        >>> selectors = ['ZONE', 'REGION']
-        >>> selection = [['Nansen','Larsson'], ['SegmentA']]
-        >>> reference = 'rms_seed'
-        >>> scale = 'percentage'
-        >>> cutbyref = True
-        >>> sortsens = False
-        >>> (tornadotable, ref_value) = calc_tornadoinput(
+    Example:
+        >> import pandas as pd
+        >> from semeio.fmudesign import calc_tornadoplot
+        >> designtable = pd.read_csv('designsummary.csv')
+        >> results = pd.read_csv('resultfile.csv')
+        >> response = 'STOIIP_OIL'
+        >> selectors = ['ZONE', 'REGION']
+        >> selection = [['Nansen','Larsson'], ['SegmentA']]
+        >> reference = 'rms_seed'
+        >> scale = 'percentage'
+        >> cutbyref = True
+        >> sortsens = False
+        >> (tornadotable, ref_value) = calc_tornadoinput(
             designtable, results, response, selectors,
             selection, reference, scale, cutbyref, sortsens)