From 3a1a890a9e5b55c2c79e0ff657ce7422286b09f0 Mon Sep 17 00:00:00 2001
From: Michiel Cottaar <MichielCottaar@gmail.com>
Date: Thu, 14 Feb 2019 09:18:47 +0000
Subject: [PATCH] DOC: clarified usage of None in updating
---
fsl/utils/filetree/filetree.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/fsl/utils/filetree/filetree.py b/fsl/utils/filetree/filetree.py
index 93bf98070..e86f93c04 100644
--- a/fsl/utils/filetree/filetree.py
+++ b/fsl/utils/filetree/filetree.py
@@ -187,10 +187,10 @@ class FileTree(object):
def update(self, **variables) -> "FileTree":
"""
- Creates a new filetree with updated variables
+ Creates a new FileTree with updated variables
:param variables: new values for the variables
- Setting variables to None will explicitly unset them
+ Setting variables to None will force that variable to be empty (useful for non-optional variables)
:return: New FileTree with same templates for directory names and filenames, but updated variables
"""
new_tree = deepcopy(self)
--
GitLab