search

svtk / AtomicKotlinCourse

87 stars 21 forks source link

Confusing text or typos in _ and Number Types Exercise 2 #23

Closed joelneely closed 3 years ago

joelneely commented 3 years ago

Thanks for the course!

The wording of the instructions for String Templates Exercise 5 is a bit confusing on first reading. The last sentence says:

Rename the val name to result without renaming "answer" in the string literal.

But the val name (answer) inside the String template should be changed without changing the caption "The answer is" before it. Perhaps is is the word "renaming" near the end of the sentence that is confusing, and it could read something like the following with less opportunity for confusion.

Rename the val name to result without changing the word "answer" in the rest of the string template.

Also, the instructions for Number Types Exercise 2 seems to contain a typo, with an extra '^' character at the end of each expression. For example, the first bulleted item reads "A million (10^6^)" but if the reader is supposed to interpret '^' as exponentiation, the second occurrence would be invalid. (If that should be markup to format the '6' as a superscript, it is not being displayed that way in the GUI.)

BruceEckel commented 3 years ago

Thanks, Joel!

Svetlana, I assume you're automatically seeing these reports, is that correct?

Bruce Eckel MindViewLLC.com Blog: BruceEckel.com EvolveWork.co WinterTechForum.com http://www.WinterTechForum.com OnJava8.com http://www.OnJava8.com www.AtomicKotlin.com Reinventing-Business.com http://www.Reinventing-Business.com

On Mon, Jun 14, 2021 at 5:43 AM Joel Neely @.***> wrote:

Thanks for the course!

The wording of the instructions for String Templates Exercise 5 is a bit confusing on first reading. The last sentence says:

Rename the val name to result without renaming "answer" in the string literal.

But the val name (answer) inside the String template should be changed without changing the caption "The answer is" before it. Perhaps is is the word "renaming" near the end of the sentence that is confusing, and it could read something like the following with less opportunity for confusion.

Rename the val name to result without changing the word "answer" in the rest of the string template.

Also, the instructions for Number Types Exercise 2 seems to contain a typo, with an extra '^' character at the end of each expression. For example, the first bulleted item reads "A million (10^6^)" but if the reader is supposed to interpret '^' as exponentiation, the second occurrence would be invalid. (If that should be markup to format the '6' as a superscript, it is not being displayed that way in the GUI.)

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/svtk/AtomicKotlinCourse/issues/23, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHUTLB7OV5IABTP3EAOVGDTSXTPXANCNFSM46VCDVCA .

svtk commented 3 years ago

Yes. Thank you for the feedback! I've updated the wording for 'String Templates Ex 5' description: https://github.com/svtk/AtomicKotlinCourse/commit/b1f2ec21684abb1fa06dd23d7e4c1fcbeb6629db.

svtk commented 3 years ago

It was indeed intended to be a markdown superscript font (which probably stopped working for some reason). I've replaced it with HTML tags: https://github.com/svtk/AtomicKotlinCourse/commit/f0278aa901fcf7f3c8d277a440bdb4c98aeb0065. Thanks for pointing it out!

joelneely commented 3 years ago

Thanks very much to both of you, for your work and ongoing support for Atomic Kotlin!