git-novice
git-novice copied to clipboard
Recommended comments to clarify sections
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
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.
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.