[V3] Improve Concept Exercise In-Text Code Examples

[BethanyG]

This issue describes how to improve the in-text code examples across concept exercises for the Python track.

Goal

We've added multiple concepts from multiple contributors while re-working our concept exercise documentation. These different exercises have diverged in the way they describe and display different Python code examples in-text. Now that things have settled a bit organizationally, we need to go back to these exercises and audit/edit the code examples for consistency.

Specifically:

• All in-text code examples should follow the same convention that is used in the Python Docs, and the Doctest Module -- i.e., the code should look exactly like what a student would see if they typed it directly into a REPL:

• All code comments, variable names, and other syntax features should follow PEP-8 guidelines as much as possible.

• In particular, single-letter variable names should be avoided, as should name shadowing (e.g., naming a variable after a data type or a method name without a qualifier)

• All code should be runnable in a Python 3.7 + shell/REPL, and should give out the correct results and error messages. Where different versions of Python differ, it should be noted/explained in the text, or another example should be given.

• All code should be accurate (some code examples contain erroneous error messages or typos).

---

Below is a quick tracking table of the concept exercises that have thus far been merged. Because of the number of files, recommend each edited exercise get its own PR.

Exercise Directory	Concept Directory	Reviewed	Revised
chaitanas-collossal-coaster	[list-methods]()	[  ]	[  ]
elyses-enchantments	lists	[  ]	[  ]
ghost-gobble-arcade-game	bools	[  ]	[  ]
guidos-gorgeous-lasagna	basics	[  ]	[  ]
inventory-management	dicts	[  ]	[  ]
log-levels	enums	[  ]	[  ]
making-the-grade	loops (not yet written)	[  ]	[  ]
processing-logs	str	[  ]	[  ]
restaurant-rozalynn	none (not yet written)	[  ]	[  ]
cater-waiter	sets (not yet written)	[  ]	[  ]
little-sisters-essay (str-methods)	string-methods	[  ]	[  ]
tisbury-treasure-hunt	tuples	[  ]	[  ]

Help

If you have any questions while improving the exercise, please post the questions as comments in this issue, or contact the maintainers for python in the #maintaing-python or #V3 Slack channels.

[BethanyG]

I think we need to call a pause on this.
We're currently in the middle of revising the markdown standard and we're also in the middle of thinking through linting & tooling and in a push to get new exercises completed.
Several exercises on this list now also need a revision or re-write due to shifting concepts/ideas.

I propose we not review any more exercises until we've got things a little more stabilized, and can know that the only thing we're checking for is code formatting or small language/tone and punctuation changes.

[github-actions[bot]]

This issue has been automatically marked as abandoned 🏚 because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[BethanyG]

Removing abandoned label, as this is on hold, but not yet abandoned.

[BethanyG]

Closing this in favor of individual improvement issues. Having one issue cross multiple exercises is too chaotic, so we'll be taking each exercise or concept review/improvement individually.