Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specify text to immediately after opening text editor #709

Open
gimode opened this issue Dec 9, 2019 · 2 comments
Open

Specify text to immediately after opening text editor #709

gimode opened this issue Dec 9, 2019 · 2 comments

Comments

@gimode
Copy link

@gimode gimode commented Dec 9, 2019

The git-novice workshop is really good, and I got to learn about git fairly sufficiently without prior experience in it.
However, the lessons instruct the learner to edit texts as the lessons progress. Typically as exemplified beginning at episode 4 "Tracking changes", the instruction is:
$ nano mars.txt
which is immediately followed by;
$ cat mars.txt
and the output shows the edited text.

For some learners who are just getting acquinted with Unix and then git, there may be some confusion.
I suggest that the exact text to be added be given in an instruction prior to the request to open the text editor.
For example:

Now suppose Dracula adds the following information to the file"The two moons may be a problem for Wolfman"
$ nano mars.txt
$ cat mars.txt

Output
Cold and dry, but everything is my favorite color
The two moons may be a problem for Wolfman

Thanks

@sgolley
Copy link

@sgolley sgolley commented Jul 10, 2020

My read of how the second edit is constructed is that it assumes familiarity with the steps performed at the start of the lesson. This could be complicated by working with new environments and/or text editors.

I think the above suggestion is good for clarity, and would also suggest being explicit in what we're adding to the file using the code format, mirroring the initial text written at the start of the lesson.

$ nano mars.txt
Add the text below into the mars.txt file:

The two moons may be a problem for Wolfman

And verify the file has changed by running
$ cat mars.txt

Output:
Cold and dry, but everything is my favorite color
The two moons may be a problem for Wolfman

@kekoziar
Copy link
Contributor

@kekoziar kekoziar commented Jul 25, 2021

Thanks for the feedback. Someone added the text

(Again, we’ll edit with nano and then cat the file to show its contents; you may use a different editor, and don’t need to cat.)

right above the commands when the second line is added to the file. Do you think this explanation is enough? It might be very cluttered if each nano cat pairing needs explicit instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants