kalekundert / stepwise

Modular, command-line scientific protocols
GNU General Public License v3.0
3 stars 0 forks source link

`step`: specify paragraphs/list items using positional arguments #50

Open kalekundert opened 3 years ago

kalekundert commented 3 years ago

I'd like to change the sw step command-line interface such that paragraphs/list items can more easily be specified over multiple lines. Specifically, I'm imagining that each argument would be it's own paragraph, with the first character determining what type of paragraph it is (e.g. paragraph list, unordered list, etc.):

sw step \
    "Lorem ipsum" \
    "- Dolor sit amet" \
    "- Consectetur adipiscing elit" 

instead of:

sw step "Lorem ipsum~Dolor sit amet~Consectetur adipiscing elit" 

I find that the latter often ends up hard to read, because it extends too far off the edge of the screen.

It's worth noting that it's already possible to break the step over multiple lines, as shown below. Perhaps that's good enough. But there's something parsimonious about each argument being its own paragraph.

sw step "Lorem ipsum
~Dolor sit amet
~Consectetur adipiscing elit"