Comments

funcs/other/generators.py

@@ -4,48 +4,65 @@ import logging
 
 logging.basicConfig(filename="gwendolyn.log", level=logging.INFO)
 
+# Returns a list of all letter pairs in the text
 def make_pairs(corpus):
     for i in range(len(corpus)-1):
         yield (corpus[i], corpus[i+1])
 
+# Generates a random name
 def nameGen():
+    # Makes a list of all names from "names.txt"
     names = open('resources/names.txt', encoding='utf8').read()
     corpus = list(names)
 
+    # Makes a list of pairs
     pairs = make_pairs(corpus)
 
-    word_dict = {}
+    letter_dict = {}
 
-    for word_1, word_2 in pairs:
-        if word_1 in word_dict.keys():
-            word_dict[word_1].append(word_2)
+    # Makes a dictionary of all letters that come after all other letters
+    for letter_1, letter_2 in pairs:
+        if letter_1 in letter_dict.keys():
+            letter_dict[letter_1].append(letter_2)
         else:
-            word_dict[word_1] = [word_2]
+            letter_dict[letter_1] = [letter_2]
 
-    first_word = random.choice(corpus)
+    # Choses a random first letter
+    first_letter = random.choice(corpus)
 
-    while first_word.islower() or first_word == " " or first_word == "-" or first_word == "\n":
-        first_word = random.choice(corpus)
+    # Makes sure the first letter is not something a name can't start with. 
+    while first_letter.islower() or first_letter == " " or first_letter == "-" or first_letter == "\n":
+        first_letter = random.choice(corpus)
 
-    chain = [first_word]
+    # Starts the name
+    chain = [first_letter]
 
     done = False
 
+    # Creates the name one letter at a time
     while done == False:
-        new_letter = random.choice(word_dict[chain[-1]])
+        new_letter = random.choice(letter_dict[chain[-1]])
         chain.append(new_letter)
+        # Ends name if the name ends
         if new_letter == "\n":
             done = True
     genName = "".join(chain)
     print("Generated "+genName)
     logging.info("Generated "+genName)
+    # Returns the name
     return(genName)
 
+# Generates a random tavern name
 def tavernGen():
+    # Lists first parts, second parts and third parts of tavern names
     fp = ["The Silver","The Golden","The Staggering","The Laughing","The Prancing","The Gilded","The Running","The Howling","The Slaughtered","The Leering","The Drunken","The Leaping","The Roaring","The Frowning","The Lonely","The Wandering","The Mysterious","The Barking","The Black","The Gleaming","The Tap-Dancing","The Sad","The Sexy","The Artificial","The Groovy","The Merciful","The Confused","The Pouting","The Horny","The Okay","The Friendly","The Hungry","The Handicapped","The Fire-breathing","The One-Eyed","The Psychotic","The Mad","The Evil","The Idiotic","The Trusty","The Busty"]
     sp = ["Eel","Dolphin","Dwarf","Pegasus","Pony","Rose","Stag","Wolf","Lamb","Demon","Goat","Spirit","Horde","Jester","Mountain","Eagle","Satyr","Dog","Spider","Star","Dad","Rat","Jeremy","Mouse","Unicorn","Pearl","Ant","Crab","Penguin","Octopus","Lawyer","Ghost","Toad","Handjob","Immigrant","SJW","Dragon","Bard","Sphinx","Soldier","Salmon","Owlbear","Kite","Frost Giant","Arsonist"]
     tp = [" Tavern"," Inn","","","","","","","","",""]
+
+    # Picks one of each
     genTav = random.choice(fp)+" "+random.choice(sp)+random.choice(tp)
     print("Generated "+genTav)
     logging.info("Generated "+genTav)
+
+    # Return the name
     return(genTav)

funcs/other/movie.py

@@ -4,6 +4,7 @@ import logging
 
 logging.basicConfig(filename="gwendolyn.log", level=logging.INFO)
 
+# Picks a random movie and returns information about it
 def movieFunc():
 	try:
 		print("Creating IMDb object")