Clarified stage_subpath behaviour

snowflakedb · May 8, 2024 · 3472fe2 · 3472fe2
1 parent 90d8c95
commit 3472fe2
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/snowflake/cli/plugins/stage/diff.py b/src/snowflake/cli/plugins/stage/diff.py
@@ -229,7 +229,8 @@ def compute_stage_diff(
 
 def get_stage_subpath(stage_path: StagePath) -> str:
     """
-    Returns the parent stage path (i.e. prefix or folder) for a given stage file path.
+    Returns the parent portion of a stage path, as a string, for inclusion in the fully qualified stage path. Note that
+    '.' treated specially here, and so the return value of this call is not a `StagePath` instance.
     """
     parent = str(stage_path.parent)
     return "" if parent == "." else parent