carpentries-incubator / python-intermediate-development-earth-sciences

Intermediate Research Software Development Skills In Python for Earth Sciences
https://carpentries-incubator.github.io/python-intermediate-development-earth-sciences/
Other
4 stars 3 forks source link

Suggestion for _episode 21 #51

Open emmasimp opened 6 months ago

emmasimp commented 6 months ago

In the first code box: $ git switch develop $ git branch -c test-suite

Would it be better to use $ git checkout -b test-suite

So you are automatically switched to the new test-suite branch? Or include the extra command $ git switch test-suite

Because I dont think later in the code when it comes time to commit to the test-suite branch we actually say make sure to switch to the correct branch.

douglowe commented 6 months ago

Ahh, yes, it would be better to use git switch -c test-suite rather than git branch -c test-suite. We do mention this in the previous lesson in a call-out box, so we could use the command here and shouldn't confuse anyone. I'll change the material now.

douglowe commented 6 months ago

Or, should I switch to this code:

git branch -c develop test-suite
git switch test-suite

The original code depends on us being in the branch we want to base the new branch on - which is an implicit assumption that might not be clear to the student. Whereas this code explicitly choses the original branch you want to copy.

Perhaps it is better to switch to using switch in the main material, as noted above, and then add a call-out box for this explicit method above? Or is this going to confuse our students even more?