lc-shell icon indicating copy to clipboard operation
lc-shell copied to clipboard

Lesson 2 - Explaining arguments/flags more clearly

Open SarahKateSchafer opened this issue 5 years ago • 1 comments

This refers to Lesson 2 in the Unix Shell - https://librarycarpentry.org/lc-shell/02-navigating-the-filesystem.html

When arguments/flags are first mentioned in Lesson 2, their function could be made clearer. For example, an explanation that with command ls: -l is for outputting as a long list; -h is for outputting in human-readable form; and -S is for sorting (largest first).

These are covered in more detail later, but when they first appear, it is quite cryptic!

SarahKateSchafer avatar Sep 16 '20 14:09 SarahKateSchafer

It would be great if you could suggest ways of working these explanations into the lesson text.

Here are the relevant parts for comparison:

https://github.com/LibraryCarpentry/lc-shell/blob/0366d2d8b3dd965c6c55f397a77eb0b51a0c0c14/_episodes/02-navigating-the-filesystem.md#L59-L61

https://github.com/LibraryCarpentry/lc-shell/blob/0366d2d8b3dd965c6c55f397a77eb0b51a0c0c14/_episodes/02-navigating-the-filesystem.md#L81-L83

(The grammar in the above extract could do with some attention, and what it says is not what it means.)

https://github.com/LibraryCarpentry/lc-shell/blob/0366d2d8b3dd965c6c55f397a77eb0b51a0c0c14/_episodes/02-navigating-the-filesystem.md#L248-L255

alex-ball avatar Oct 26 '20 12:10 alex-ball