Skip to content

Commit 7156677

Browse files
committed
update docstring
running this through gerrit just to see some final cleanups on jenkins Change-Id: I2905523cb3df33f2cc7400d010fca002bf34748c
1 parent b54aee5 commit 7156677

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

tools/toxnox.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,17 @@ def _recur_param(prevtokens, prevtags, token_lists):
198198

199199

200200
def extract_opts(posargs: List[str], *args: str) -> Tuple[List[str], Any]:
201+
"""Pop individual flag options from session.posargs.
201202
203+
Returns a named tuple with the individual flag options indicated,
204+
as well the new posargs with those flags removed from the string list
205+
so that the posargs can be forwarded onto pytest.
206+
207+
Basically if nox had an option for additional environmental flags that
208+
didn't require putting them after ``--``, we wouldn't need this, but this
209+
is probably more flexible.
210+
211+
"""
202212
underscore_args = [arg.replace("-", "_") for arg in args]
203213
return_tuple = collections.namedtuple("options", underscore_args)
204214

0 commit comments

Comments
 (0)