logs-logs-logs: update concept and exercise content #1707
Conversation
sudomateo
changed the title
There was a problem hiding this comment.
Thanks a ton! I've left some comments on your PR. @junedev could you also take a look?
| @@ -1,16 +1,100 @@ | |||
| # Introduction | |||
There was a problem hiding this comment.
The introduction is currently quite long (same goes for the concept introduction.md document). Are there maybe places where you cut down a little on the information? It might be worth keeping the following two parts from the docs in mind:
- The information provided should give the student just enough context to figure out the solution themselves.
- Only information that is needed to understand the fundamentals of the concept and solve the exercise should be provided. Extra information should be left for the concept's about.md document.
There was a problem hiding this comment.
Made some changes. Feel free to review.
concepts/runes/about.md
Outdated
|
|
||
| ## Runes and Strings | ||
|
|
||
| Since Go source code files are encoded using UTF-8, strings in Go are also encoded using UTF-8. That means strings in Go contain Unicode characters. Since a `rune` type is meant to represent a Unicode character, a string in Go is often referred to as a sequence of runes. Taking this one step further, since runes are stored as 1, 2, 3, or 4 bytes, a string can also be referred to as a sequence of bytes. Go uses slices to represent such sequences, and these slices can be iterated over using `range`. |
There was a problem hiding this comment.
The main takeaway of the section below should be that range for strings iterates over characters not bytes. Currently that is somewhat hidden. Besides making the text a bit clearer on this, I would recommend to change the first example to also include a special character so it becomes visible.
There was a problem hiding this comment.
Updated! Feel free to review.
concepts/runes/about.md
Outdated
|
|
||
| ## Runes and Strings | ||
|
|
||
| Since Go source code files are encoded using UTF-8, strings in Go are also encoded using UTF-8. That means strings in Go contain Unicode characters. Since a `rune` type is meant to represent a Unicode character, a string in Go is often referred to as a sequence of runes. Taking this one step further, since runes are stored as 1, 2, 3, or 4 bytes, a string can also be referred to as a sequence of bytes. Go uses slices to represent such sequences, and these slices can be iterated over using `range`. |
There was a problem hiding this comment.
From the text I find it hard to understand that a string is a slice of bytes but is NOT a slice of runes because of the UTF8 encoding (but it can be converted to one as you explained elsewhere).
There was a problem hiding this comment.
Updated! Feel free to review.
|
Implemented most of the feedback. I wanted to finish all of it before calling it a night but my brain is just not cooperating. I know there's a push to have this implemented before October so I apologize for the delay here! I'll work on it again tomorrow after some rest. |
|
@sudomateo Sure. Give us a shout when we can review the PR again. |
junedev
added
status/awaiting-contributor
|
@ErikSchierboom and @junedev this is ready for review! Thank you for your patience. |
|
@sudomateo Thanks for the update. Could you have another look at 2 things before I merge this.
|
- Introduce `utf8.RuneCountInString` in the content. - Reorder sections.
|
Updated! |
|
All good now @sudomateo, thanks! I am merging this now. If we want to make more improvements in the future (e.g. shortening the introduction even more) we can do another PR. |
|
Works for me! Thanks for the reviews! |
This patch adds the
Runesconcept and alogs-logs-logsexercise to Exercism's Go track. TheRunesconcepts teaches users UTF-8 encoding and shows that strings are a slice of bytes that can be read as bytes or characters (i.e.,rune). Thelogs-logs-logsexercise tests that users know how to work with strings in Go.This is part of the September 2021 sprint.
Closes #1594
Closes #1595
Closes #1596
Closes #1614