From 2b5f46ae0b223d753ac52b608c7aadf5b4a3443e Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Tue, 14 Jun 2022 08:13:52 +0100 Subject: [PATCH] Fix docstring of 'check_dataset' function. (#57) --- README.md | 3 +-- lib/ugrid_checks/check.py | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8c81c70..a5252d1 100644 --- 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 index 1259f6e..0d62702 100644 --- 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 -------