carpentries / carpentries/lesson-example

Should code boxes show a prompt?

Open
#376 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
65
Forks
167
PR merge metrics
No merged PRs in 30d

Description

I can't seem to find if this is detailed anywhere. In the shell-novice lesson the code boxes show the `$` prompt ahead of the command to be run, and this pattern is followed also in the MATLAB-novice, and make-novice lessons. In the python and R lessons there is no prompt.

Is there guidance as to which approach should be taken and why (not)? It would make sense to be consistent across lessons, or to document why there is a difference. I can see reasons for and against.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.