Auslegungssache...

Aufgabe

Gute Dokumentation beschränkt sich nicht nur auf Kommentare, sondern auch auf sinnvoll benannte Variablen und Funktionen, sowie die Ausgaben im Terminal.
Durch eine sinnvolle Wahl von Variablennamen, kann der Code für Sie und andere wesentlich verständlicher gemacht werden.
Meistens fällt einem die Wahl von schlechten Namen erst auf, wenn man mit diesen konfrontiert wird.
Der Name einer Variable sollte die Bedeutung und Inhalt der Variable beschreiben. Betrachten Sie den unten gegebenen Code und benennen Sie die Variablen und Funktionen sinnvoll um.

Beispiele:

Achtung Spoiler!

Es ist nicht hilfreich, wenn die Variable nur den Typ beschreibt.
meine_zahl = 42 beschreibt immerhin, um welchen Typ es geht. Besser wäre aber z.B. standard_faktor = 42, wenn es z.B. um die Skalierung von Dingen geht.

Gute Beispiele wären:

faktor_1 = 32
faktor_2 = 2
produkt = faktor_1 * faktor_1

def sag_es_zwei_mal(nachricht):
    print(nachricht)
    print(nachricht)

nutzer = "Wusel"
begrüßung = "Hallo " + nutzer + " !"
sag_es_zwei_mal(begrüßung)

Bonus:

Fügen Sie auch hier deskriptive Kommentare hinzu.

1.

verabschiedung = "Hi, schön, dass du da bist!"
print(verabschiedung)
begrüßung = "Bis später!"
print(begrüßung)

2.

zux = 0
xflux = 10

# das ist eine while schleife, die für immer läuft
for i in range(zux, xflux):
    print(i)

3.

def multipy(qvz, abc):
    # Funktion, die sdlhvbdöfyknv
    return qvz + abc

fasgdkflhj = multipy(8, 9)
print("Das Ergebnis der Multiplikation ist:")
print(fasgdkflhj)

4.

# Hinweis: input wartet auf eine Eingabe im Terminal
# Sie tippen einfach etwas im Terminal und bestätigen die Eingabe mit [Enter]
# Danach läuft das Programm weiter
ergebnis = input("gib eine zahl ein: ")

ergebnis_als_string = int(ergebnis)  # k.a. was hier passiert

eingabe = ergebnis_als_string * 4  # eh. rechnen?

print("bhjsbdflvgaönsfv")
print(eingabe)

5.

# Hinweis: Mit der random Bibliothek können Zufallszahlen generiert werden 
import random

# Hinweis: random.randint(a, b) erzeugt eine Ganzzahl zwischen a und b
sleeptoken = random.randint(1, 10)

if sleeptoken % 2 == 0:
    spiritbox = True
else:
    spiritbox = True
    
if spiritbox:
    print("Wir haben etwas über die Zahl festgestellt:")
else:
    print("Etwas anderes über die Zahl gilt:")

print("???")
print(sleeptoken)

6.

Die ultimative Challenge (*10.000 Punkte*)!
Tauschen Sie sich mit Ihren Sitznachbar:innen (und Tutor:innen) über die gewählten Namen aus.
Hier gibt es hier kein objektives Richtig oder Falsch, aber andere Meinungen können sehr helfen einem “objektiveren Richtig” näher zu kommen.
Ja, Menschen ansprechen ist gruselig und die Person neben Ihnen wird sich genau so davor fürchten. Wenn Sie sich aber jetzt trauen, könnte das der Beginn einer großartigen Freundschaft werden! :)

Tipp

Achtung Spoiler!

Nutzen Sie genau diese Aufgabe als Aufhänger, um das Gespräch zu suchen.
Schieben Sie die Schuld auf die blöde Aufgabe und deren gemeinen Ersteller (: