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

Incomplete output from cat in Episode 4, "Committing Multiple Files" #695

Closed
LouiseABowler opened this issue Oct 1, 2019 · 8 comments · Fixed by #837
Closed

Incomplete output from cat in Episode 4, "Committing Multiple Files" #695

LouiseABowler opened this issue Oct 1, 2019 · 8 comments · Fixed by #837

Comments

@LouiseABowler
Copy link

@LouiseABowler LouiseABowler commented Oct 1, 2019

The first step of the "Committing Multiple Files" exercise in Episode 4 is to add a new line of text to mars.txt. The command cat mars.txt is then used to examine the contents of the file before proceeding.

The solution shows that the output of the cat command should be

Maybe I should start with a base on Venus.

but it actually shows all the text in mars.txt, which at this point is

Cold and dry, but everything is my favorite color
The two moons may be a problem for Wolfman
But the Mummy will appreciate the lack of humidity
Maybe I should start a base on Venus.

When I went through the exercise I wasn't sure whether the text had intentionally been cut for brevity, was unintentionally incomplete or whether I should have replaced the earlier lines in the file. (I'd guess not the last option as the solution's commit log says "2 insertions" only.) If someone could clarify, I'd be happy to open a PR to fix 😄

@tdido
Copy link

@tdido tdido commented Oct 23, 2019

Seems like there is a related problem also in the next episode. Right at the beginning, the output of cat mars.txt after adding a new line as indicated is listed as:

Cold and dry, but everything is my favorite color
The two moons may be a problem for Wolfman
But the Mummy will appreciate the lack of humidity
An ill-considered change

Ignoring the Maybe I should start a base on Venus. line added in the exercise @LouiseABowler mentions.

Maybe a PR to get all this back in sync is needed?

@kekoziar
Copy link
Contributor

@kekoziar kekoziar commented Oct 23, 2019

Since instructors will pick and choose different exercises to complete during workshops, the output varies. To avoid the lesson becoming cluttered by reflecting all possible scenarios of zero to all exercises, the lesson output reflects changes made by the lesson, but not the exercises. I hope this explanation clarifies any confusion.

@tdido
Copy link

@tdido tdido commented Oct 24, 2019

I see. That would explain my case then, but @LouiseABowler 's comment still stands, since the exercise should show the content that has been added during the main lesson body, right?

@kekoziar
Copy link
Contributor

@kekoziar kekoziar commented Jul 31, 2021

The exercises don't always show the content from the main lesson body. They are created to supplement the episode as formative assessment, and not necessarily extend content in the episode.

While exercises are listed at the end of the episode, each instructor may identify which exercise(s) they want to use during their workshop and when. In this case, when the exercise is covered during the workshop will predicate the output of cat mars.txt. Depending on placement, cat mars.txt may show zero to four lines preceding Maybe I should start with a base on Venus. Since we can't include all possible variations, we chose to only output the line added during the exercise.

How about adding a note in the exercise solution along the lines of,

This cat mars.txt only reflects content added during the exercise.

?

@tdido
Copy link

@tdido tdido commented Aug 2, 2021

I see. I guess my confusion spans from the assumption that the lessons should be easily used as a tutorial. In that case this confusion would arise. If you're being led by an instructor I agree it would not really matter.

Your note idea seems to be a good one. But how about a more generic:

The output from cat mars.txt may vary depending on the specific commands you executed in previous exercises

@kekoziar
Copy link
Contributor

@kekoziar kekoziar commented Aug 2, 2021

How about

The output (above/below - depending on placement) from cat mars.txt reflects only content added during this exercise. Your output may vary.

?

@tdido
Copy link

@tdido tdido commented Aug 2, 2021

Yes, that should work. Not sure I understand the part between parentheses, but the note will surely be of help.

@kekoziar
Copy link
Contributor

@kekoziar kekoziar commented Aug 7, 2021

The parenthetical remark indicates that the word above or below should be added to the sentence depending on placement in relation to the output.

annajiat added a commit to annajiat/git-novice that referenced this issue Aug 13, 2021
annajiat added a commit to annajiat/git-novice that referenced this issue Aug 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

3 participants