search

cproctor / qualitative-coding

Qualitative coding for computer scientists
Other
12 stars 3 forks source link

Documentation suggestion #53

Closed cmaimone closed 3 months ago

cmaimone commented 3 months ago

Suggestions, not review requirements:

Specify a language for your code blocks in the documentation to improve readability via syntax highlighting. Many qualitative analysts are not very experienced with command line, so every little bit helps. For example, something like the Bash lexer might work to show the prompt vs. the command vs. the output more clearly

It may also help to do a pass through to check that all commands that should be typed start with the command prompt $ and output is distinguished differently. The only command I've noticed missing the prompt so far is the installation command pipx install qualitative-coding. It may also be useful to state in the installation section and somewhere at the beginning of the vignette that $ is the command line prompt and they shouldn't type it.

Just something that we've learned from working with novice command line users in the past.

re: https://github.com/openjournals/joss-reviews/issues/7031

cproctor commented 3 months ago

Thanks! I didn't know about the rst lexers; I was able to achieve exactly the desired effect, with the shell prompt displayed but not selectable. I also added a note at the top of the documentation.