@@ -113,7 +113,8 @@ def _do_add(
113
113
) -> None :
114
114
"""Create a Variable and add it to the list.
115
115
116
- Internal routine, not public API.
116
+ This is the internal implementation for :meth:`Add` and
117
+ :meth:`AddVariables`. Not part of the public API.
117
118
118
119
.. versionadded:: 4.8.0
119
120
*subst* keyword argument is now recognized.
@@ -157,15 +158,16 @@ def Add(
157
158
"""Add a Build Variable.
158
159
159
160
Arguments:
160
- key: the name of the variable, or a 5-tuple (or list).
161
- If *key* is a tuple, and there are no additional positional
162
- arguments, it is unpacked into the variable name plus the
163
- *help*, *default*, *validator* and *converter keyword args.
164
- If *key* is a tuple and there are additional positional arguments,
165
- the first word of the tuple is taken as the variable name,
166
- and the remainder as aliases.
161
+ key: the name of the variable, or a 5-tuple (or other sequence).
162
+ If *key* is a tuple, and there are no additional arguments
163
+ except the *help*, *default*, *validator* and *converter*
164
+ keyword arguments, *key* is unpacked into the variable name
165
+ plus the *help*, *default*, *validator* and *converter*
166
+ arguments; if there are additional arguments, the first
167
+ elements of *key* is taken as the variable name, and the
168
+ remainder as aliases.
167
169
args: optional positional arguments, corresponding to the
168
- *help*, *default*, *validator* and *converter keyword args.
170
+ *help*, *default*, *validator* and *converter* keyword args.
169
171
kwargs: arbitrary keyword arguments used by the variable itself.
170
172
171
173
Keyword Args:
@@ -174,7 +176,7 @@ def Add(
174
176
validator: function called to validate the value (default: ``None``)
175
177
converter: function to be called to convert the variable's
176
178
value before putting it in the environment. (default: ``None``)
177
- subst: if true perform substitution on the value before the converter
179
+ subst: perform substitution on the value before the converter
178
180
and validator functions (if any) are called (default: ``True``)
179
181
180
182
.. versionadded:: 4.8.0
0 commit comments