Fix docstring of 'check_dataset' function. (#57)

pp-mo · Jun 14, 2022 · 2b5f46a · 2b5f46a
1 parent cd84cf2
commit 2b5f46a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -186,8 +186,7 @@ Within Python, the module can be used like this :
         A list of error codes to ignore.
     max_data_mb : float, default 200.0
         A rough size threshold (in Mb), beyond which we will skip data checks.
-        Default is 0 = no data checks.
-        Can also set to -1 for "no limit".
+        Set to 0 for no checking, or -1 for no size limit.
 
     Returns
     -------

diff --git a/lib/ugrid_checks/check.py b/lib/ugrid_checks/check.py
@@ -1988,8 +1988,7 @@ def check_dataset(
         A list of error codes to ignore.
     max_data_mb : float, default 200.0
         A rough size threshold (in Mb), beyond which we will skip data checks.
-        Default is 0 = no data checks.
-        Can also set to -1 for "no limit".
+        Set to 0 for no checking, or -1 for no size limit.
 
     Returns
     -------