git-novice icon indicating copy to clipboard operation
git-novice copied to clipboard

Recommended comments to clarify sections

Open SARAHHETTEMA opened this issue 2 years ago • 1 comments

I noticed a few areas where comments in the code could help clarify next steps and avoid running into error messages:

In the directories section (https://swcarpentry.github.io/git-novice/04-changes/index.html#directories): there is a code block "git add ". I think it would be helpful to add a comment such as "#use this general form to add all files in the directory at once" or remove the code formatting. I find it can be confusing to have a code chunk that is not supposed to be executed in the lesson without some additional commentary that the line of code is just example formatting.

In the Ignoring things episode (https://swcarpentry.github.io/git-novice/06-ignore/index.html#overview): for the "nano .gitignore" line. I would add a comment to the output section that you need to edit the nano file with the "*.dat results/" text then run git status. I think either a comment next to the nano line or a line before the code chunk would clarify and prevent folks from getting stuck on that section.

SARAHHETTEMA avatar Sep 01 '22 21:09 SARAHHETTEMA

HI @SARAHHETTEMA,

These are really helpful suggestions! Thank you for making them. I think both suggestions are worth incorporating into the lesson. I might work with the lesson maintainers to see if I can draft some revisions.

emcaulay avatar Sep 14 '22 23:09 emcaulay