Skip to content

Clarify mixin argument application order in parse_args docstring #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ultrasage-danz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify mixin argument application order in parse_args docstring #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions colcon_mixin/mixin/mixin_argument.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,12 @@ def parse_known_args(self, *args, **kwargs):
return (known_args, remaining_args)

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