[Typo Patrol]: Typos & Similar Errors in Concept Exercise instructions, stub docstrings, & exemplar docstrings.

[Yrahcaz7]

As per this forum post, this issue will be a collection of all typos and similar errors I find from now on, grouped by exercise.

• Locomotive Engineer concept exercise:
  • Typos in the docstrings in the stub:
    • Line 8 has an indentation of 7 spaces instead of 8.
    • Line 21 and 59 are missing the : that is normally in between the type and description of parameters.
    • On line 34, the parameter description "arbitrary number of stops." is not capitalized. Line 62 (list[tuple]: the list of rows of wagons.) is the same.
    • On line 59, the wagons_rows parameter is said to be of type list[tuple], but it is actually of type list[list[tuple]]. The return type has the same problem (line 62).
  • The exemplar solution's docstrings have most of these issues too, as well as an extra period at the end of line 11.
  • Typos in hints.md:
    • Line 5 has incorrect grammar, it should probably be something along these lines instead: "To extract multiple arguments in the function parameters, you can pack them with the *args operator for list or tuples or **kwargs for keyword-based arguments." This replaces "parameters so can you" with "parameters, you can".
    • The comma on line 14 isn't necessary and probably isn't grammatical anyway.
    • Line 31 isn't grammatical, it should be something along these lines instead: "zip(*iterators) can be used to transpose a nested list." This replaces "can use used" with "can be used".
  • Level three headers in the introduction render as normal text instead of headers in the website's code editor. Affected headers: "Deep unpacking", "Unpacking a list/tuple with *", "Unpacking a dictionary", "Packing a dictionary with **", "Unpacking into function calls". This might just be an issue with the website, though.
• Little Sister's Essay concept exercise:
  • Typos in the docstrings in the stub and the exemplar:
    • Line 34 has an indentation of 4 spaces instead of 8.
    • Line 34 also has 2 spaces in between the type and description instead of 1.
• Currency Exchange concept exercise:
  • Typos in the docstrings in the stub and the exemplar:
    • The example for get_change() on line 45 (line 43 in the exemplar) has a period before the >>>, unlike all the other examples.
• Little Sister's Vocabulary concept exercise:
  • Typos in the docstrings in the stub and the exemplar:
    • Lines 24-25 and 28-29 are wrapped unnaturally much before the normal wrap point.
  • Typos in hints.md:
    • Section "3. Remove a suffix from a word" (lines 25-27) has code that isn't surrounded by backticks, e.g. "'beautiful'[:-3] == 'beauti'" should be 'beautiful'[:-3] == 'beauti'
• Black Jack concept exercise:
  • Typos in the docstrings in the stub and the exemplar:
    • Line 15 has two double-spaces.
    • On line 37 (46 in the exemplar), the tuple type is mentioned, but it capitalizes it as "Tuple".
• Card Games concept exercise:
  • Typos in the docstrings in the stub and the exemplar:
    • Lines 11 and 24 have 2 spaces in between the type and description instead of 1.
    • Line 38 has an extra space in between the parameter name and the type.
• Making the Grade concept exercise:
  • Typos in the docstrings in the stub and the exemplar:
    • Lines 38 and 72 (lines 45 and 88 in the exemplar) have 2 spaces in between the type and description instead of 1.
    • Line 48 (line 60 in the exemplar) seems to have a remnant of the old format: highest: int - instead of highest (int):
    • Not sure if this is intentional or not: Line 8 has list[float|int] type, which is equivalent to list[float].
  • Typos in hints.md:
    • Lines 5 and 6 have the same sentence structure, but line 5 does not have a comma while line 6 does.
    • Line 8 mentions the range syntax, but the stop placeholder is not surrounded by angled brackets: range(<start>, stop, <step>) should be range(<start>, <stop>, <step>).
    • Line 13 is missing the parentheses on the append method: <list>.append should be <list>.append().
    • Not sure if this is intentional or not: Line 25 has two hyphens in a row instead of an em-dash.
• Tisbury Treasure Hunt concept exercise:
  • Typos in the docstrings in the stub and the exemplar:
    • Line 34 has 2 spaces in between the type and description instead of 1.
  • Typos in hints.md
    • Line 6 has an incorrect capitalization: "sequence Types" should be "sequence types".
    • Line 25 says "Pythons" when in should be "Python's" in that context.
• Ellen's Alien Game concept exercise:
  • Typos in introduction.md:
    • Lines 185 and 212 have an extra space between return and self.
  • Typos in instructions.md:
    • Lines 33-38 have strange line spacing that makes the 3 look disconnected from the >>> alien.health. The # Initialized health value. comment should probably be before the >>> alien.health, or at least the blank line in-between should be removed. (If the comment location is changed, the same change should probably be applied to the case at lines 106-108 as well.)
    • Line 123 is missing the ... at the beginning of the line to indicate that it is a continuation of the >>>.
  • Typos in the stub:
    • Lines 9 and 11 have an extra space between the attribute type and description.
    • Line 24 has an extra space between (Student): and Create.
  • Typos in the docstrings in the exemplar:
    • Lines 9, 11, 32, 34, and 62 have an extra space between the attribute type and description.
    • Line 98 has an indentation of 7 spaces instead of 8.
    • Line 98 also has an extra period at the end.
  • Typos in hints.md:
    • Line 23 has code that is split into two separate portions instead of unified: "self.<attribute> = <new attribute value>" should be "self.<attribute> = <new attribute value>".
    • On the last line (line 42), the sentence ends without any punctuation.
  • Typos in the corresponding concept doc:
    • The footnote on lines 188 and 191 is a bit confusing, so it would be better if the link was just on line 188. Even if it is kept how it is, the stray underscore on line 191 should be removed.
    • Lines 243 and 270 have an extra space between return and self.
• Plane Tickets concept exercise:
  • Typos in instructions.md:
    • Line 78 has incorrect grammar, it should probably be something along these lines instead: "They want you to create a system that creates a unique ticket that is a 12 character long string code for identification." This replaces "is 12 characters long string" with "is a 12 character long string".
    • Line 81 is confusing, it should probably be something along these lines instead: "The rest of the code is filled with 0s." This replaces "is appended by 0s" with "is filled with 0s".
  • Typos in the docstrings in the stub and the exemplar:
    • On line 37 (line 42 in the exemplar), "example" is mispelled as "exampl".
    • Lines 42 and 56 (line 74 in the exemplar) are only single empty lines in between function definitions, when elsewhere in the file (and in the track as a whole) there are always two blank lines in between functions.

[github-actions]

Hello. Thanks for opening an issue on Exercism 🙂

At Exercism we use our Community Forum, not GitHub issues, as the primary place for discussion. That allows maintainers and contributors from across Exercism's ecosystem to discuss your problems/ideas/suggestions without them having to subscribe to hundreds of repositories.

This issue will be automatically closed. Please use this link to copy your GitHub Issue into a new topic on the forum, where we look forward to chatting with you!

If you're interested in learning more about this auto-responder, please read this blog post.

[BethanyG]

Tempted to play with making sub-issues here ... but probably can't afford the "yak shaving" distraction.

[BethanyG]

In going back through the Mechamuch exercise, I realized there were typos in the hints.md file as well. I DO NOT want to add to the workload (so feel free to skip these if you want), but thought I'd point you to that file as well as a source of .... 🐛 🐛 🐛 . 😄 You can find the hints.md files under the .docs directory ( https://github.com/exercism/python/blob/main/exercises/concept/<exercise name>/.docs/hints.md.)

[BethanyG]

Not sure if this is intentional or not: Line 25 has two hyphens in a row instead of an em-dash.

..just proof I'm not a bot or AI model. Purportedly, em-dashes are a sign of AI. 😆

I am particularly offended by this bit of AI accusation, but agree an em-dash should go there. 😄

[Yrahcaz7]

While I was at it, I looked through the hints.md files for all of the exercises that I already had entries for in the issue. A few of them had some typos and I added those to the list.

I'll probably leave the list as-is for now until I finish learning mode.

[Yrahcaz7]

I finished the Ellen's Alien Game and Plane Tickets exercises (though still waiting for a mentor on Plane Tickets) and added the typos I found in those to the list.

I haven't read through all the concept docs after I completed the respective exercises, though, so there might still be some unfound typos in those.