Step function help feature #1

New Issue

efelon · 2019-04-04T22:21:24+02:00

efelon commented

2019-04-04 22:21:24 +02:00

When a step function is called with first parameter -h it would only print the headline text.

Could be used to populate help and print more information before asking to continue with this step.

When a step function is called with first parameter -h it would only print the headline text. Could be used to populate help and print more information before asking to continue with this step.

efelon self-assigned this 2019-04-04 22:21:24 +02:00

efelon added the

Enhancement

label 2019-04-04 22:21:24 +02:00

efelon referenced this issue from a commit

2019-04-05 13:07:12 +02:00

Step help as own function within step definition script fixes #1

efelon closed this issue

2019-04-05 13:07:12 +02:00

efelon changed title from ~~Step function headline feature as parameter -h~~ to Step function help feature

2019-04-05 13:08:15 +02:00

efelon commented

2019-04-05 13:12:28 +02:00

Original idea modified. Help output for each step is created with own helper function:

step_1_info() - containing description which is shown in seqs help and also as headline before execution
step_1() - contains the shell commands for this step

This makes the step definition script more readable and containing the least possible overhead.

Original idea modified. Help output for each step is created with own helper function: step_1_info() - containing description which is shown in seqs help and also as headline before execution step_1() - contains the shell commands for this step This makes the step definition script more readable and containing the least possible overhead.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: efelon/shell_sequencer#1