summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Environment.py
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2017-08-31 19:57:51 -0700
committerWilliam Deegan <bill@baddogconsulting.com>2017-08-31 19:57:51 -0700
commit9c4fb40fbe108ba7ad9a37f25c2929269adbb107 (patch)
tree7f2a3a36201d9548ce6f62e742a467e07b7d8422 /src/engine/SCons/Environment.py
parent6fcbd22acf9b6bdc6cb838ae00dec2fe7af7b035 (diff)
downloadscons-9c4fb40fbe108ba7ad9a37f25c2929269adbb107.tar.gz
Fix many epydoc warnings
Diffstat (limited to 'src/engine/SCons/Environment.py')
-rw-r--r--src/engine/SCons/Environment.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/engine/SCons/Environment.py b/src/engine/SCons/Environment.py
index 6a127db5..42b28e61 100644
--- a/src/engine/SCons/Environment.py
+++ b/src/engine/SCons/Environment.py
@@ -2189,13 +2189,16 @@ class Base(SubstitutionEnvironment):
"""This function converts a string or list into a list of strings
or Nodes. This makes things easier for users by allowing files to
be specified as a white-space separated list to be split.
+
The input rules are:
- A single string containing names separated by spaces. These will be
split apart at the spaces.
- A single Node instance
- A list containing either strings or Node instances. Any strings
in the list are not split at spaces.
+
In all cases, the function returns a list of Nodes and strings."""
+
if SCons.Util.is_List(arg):
return list(map(self.subst, arg))
elif SCons.Util.is_String(arg):