Add examples for menu choices

caalberts commented 4 years ago

Describe the change

What does this Pull Request do?

Add examples for menu choices

Why are we doing this?

Any related context as to why is this is a desirable change.

Most of the example code are followed by the output illustrating how the prompt would look like to the user. Having the examples for the first code example in menu choices would help to a potential user imagine the interaction.

Benefits

How will the library improve?

It would be easier to use with more examples.

Drawbacks

Possible drawbacks applying this change.

none

Requirements

Put an X between brackets on each line if you have done the item: [] Tests written & passing locally? [] Code style checked? [x] Rebased with master branch? [x] Documentation updated?

caalberts commented 4 years ago

@piotrmurach What do you think of this change?

coveralls commented 4 years ago

Coverage increased (+0.005%) to 97.571% when pulling 31ba72c8cc6798a0e16a9694aeea38c239dcf939 on caalberts:caalberts-add-menu-choices-examples into f79196e5229f72c2f79ac3cdb7782f96bfffb61e on piotrmurach:master.

coveralls commented 4 years ago

Coverage decreased (-0.09%) to 97.476% when pulling 31ba72c8cc6798a0e16a9694aeea38c239dcf939 on caalberts:caalberts-add-menu-choices-examples into f79196e5229f72c2f79ac3cdb7782f96bfffb61e on piotrmurach:master.

piotrmurach commented 4 years ago

Thank you! ❤️

piotrmurach / tty-prompt