Skip to content

DOC: minor docstring errors from renamed cli args #201

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

Merged
ZLLentz merged 1 commit into from
Sep 12, 2024
Merged

DOC: minor docstring errors from renamed cli args #201

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
8 changes: 4 additions & 4 deletions scripts/ioc_deploy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ def main_deploy(args: CliArgs) -> int:
"""
All main steps of the deploy script.

This will be called when args has neither of apply_write_protection and remove_write_protection
This will be called when no subparser is included.

Will either return an int return code or raise.
"""
Expand Down Expand Up @@ -302,7 +302,7 @@ def main_perms(args: CliArgs) -> int:
"""
All main steps of the only-apply-permissions script.

This will be called when args has at least one of apply_write_protection and remove_write_protection
This will be called when the update-perms subparser is included.

Will either return an int code or raise.
"""
Expand Down Expand Up @@ -1065,9 +1065,9 @@ def rearrange_sys_argv_for_subcommands():
Small trick to help argparse deal with my optional subcommand.

This will make argv like this:
ioc-deploy -p some_path perms ro
ioc-deploy -p some_path update-perms ro
be interpretted the same as:
ioc-deploy perms ro -p some_path
ioc-deploy update-perms ro -p some_path

Otherwise, the first example here is interpretted as if -p was never passed,
which could be confusing.
Expand Down