Clinical-Genomics / cg

Glue between Clinical Genomics apps

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Replace parameter yes with skip_confirmation

sofstam opened this issue · comments

Description

The parameter yes in function clean_workflow_run_dir is not very clear. It would be good to be replaced with skip_confirmation instead.
#3068 (comment)

Hey, I've got a question about the scope of this issue.
Should the cli parameters like --yes also be changed?

I think keeping --yes as a CLI flag makes sense since it's the standard anywhere else. Maybe it can be accepted as skip_confirmation to any function further down the call chain?

Is it not very unclear what you are saying yes to? It would be nice to have the as self-explanatory as possible. I realize it is a bigger scope, but I would like to remove all ambiguous yes with skip_confirmation.

We could maybe change it from

OPTION_YES = click.option("-y", "--yes", is_flag=True, help="Skip confirmation")

to something like

OPTION_SKIP_CONFIRMATION = click.option("-y", "--skip-confirmation", "--yes", is_flag=True, help="Skip confirmation")

Sounds good!