From ef02a7048697c4e0af0bacfd5e5b35896b76dc07 Mon Sep 17 00:00:00 2001 From: Bas des Tombe Date: Sun, 24 Nov 2024 09:52:54 -0600 Subject: [PATCH] Update get_paths documentation --- src/nhflodata/get_paths.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/nhflodata/get_paths.py b/src/nhflodata/get_paths.py index 0c3c670..eaeafa6 100644 --- a/src/nhflodata/get_paths.py +++ b/src/nhflodata/get_paths.py @@ -29,7 +29,8 @@ def get_abs_data_path(name="", version="latest", location="get_from_env", local_ name : str Name of the data set. version : str - Version of the data set. Can be "latest" or a specific version number. + Version of the data set. Can be "latest" or a specific version number. Version numbers + must be a valid semantic version number: 1.0.0, 1.0.1, 1.1.0, etc. Corresponds to the verion_nhflo entry in repository.yaml. location : str, optional Location of the data set. Can be "mockup", "local", "nhflo_server", or "get_from_env".