Skip to content

Commit c00a55a

Browse files
Clarify mixin argument application order in parse_args docstring
1 parent ebedd27 commit c00a55a

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

colcon_mixin/mixin/mixin_argument.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,12 @@ def parse_known_args(self, *args, **kwargs):
122122
return (known_args, remaining_args)
123123

124124
def parse_args(self, *args, **kwargs):
125-
"""Add mixin argument for each parser."""
125+
"""
126+
Add mixin argument for each parser and apply selected mixins.
127+
When multiple mixins are applied, they are processed in the order specified by
128+
the user. In future versions supporting mixin referencing, referenced mixins will
129+
be applied before the mixin that references them.
130+
"""
126131
# mapping of all "leaf" verbs to parsers
127132
def collect_parsers_by_verb(root, parsers, parent_verbs=()):
128133
found_any = False
@@ -318,4 +323,4 @@ def _argparse_existing_file(path):
318323
if not os.path.isfile(path):
319324
raise argparse.ArgumentTypeError(
320325
"Path '{path}' is not a file".format_map(locals()))
321-
return path
326+
return path

0 commit comments

Comments
 (0)