Minor docs fixes

fortwoone · Dec 4, 2023 · 4490912 · 4490912
1 parent 481d27e
commit 4490912
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/docs/enumerations.rst b/docs/enumerations.rst
@@ -8,30 +8,37 @@ Related module: :mod:`pyzora.enums`
 
 .. autoclass:: pyzora.enums.GameRegion
     :members:
+    :member-order: bysource
 
 .. autoclass:: pyzora.enums.TargetGame
     :members:
+    :member-order: bysource
 
 .. autoclass:: pyzora.enums.MemoryEnum
     :members:
-    :member-order:
+    :member-order: bysource
 
 .. autoclass:: pyzora.enums.RupeesGiven
     :members:
     :undoc-members:
+    :member-order: bysource
 
 .. autoclass:: pyzora.enums.ChildBehaviour
     :members:
     :undoc-members:
+    :member-order: bysource
 
 .. autoclass:: pyzora.enums.SleepMethod
     :members:
     :undoc-members:
+    :member-order: bysource
 
 .. autoclass:: pyzora.enums.ChildKind
     :members:
     :undoc-members:
+    :member-order: bysource
 
 .. autoclass:: pyzora.enums.ChildQuestion
     :members:
     :undoc-members:
+    :member-order: bysource
diff --git a/pyzora/game_secret.py b/pyzora/game_secret.py
@@ -134,6 +134,11 @@ def __set_animal(self, value: ObtainedCompanion | int):
                       In linked games, the companion stored in the secret will
                       recognise Link and give him his flute again.
                       
+                      CAUTION: do NOT try to generate linked secrets with ObtainedCompanion.NONE as the animal
+                      friend! While Ages does have a check to prevent you from getting stuck due to the lack of an animal 
+                      friend and gives you Moosh if you input a secret with no animal friend, Seasons doesn't, and you will
+                      get stuck.
+                      
                       :type: ObtainedCompanion""")
 
     def __get_behaviour(self):