mirror of
https://github.com/ArchipelagoMW/Archipelago.git
synced 2026-10-07 23:03:03 -07:00
Add an option docstring to roll_settings to hopefully prevent the weights fiasco from being repeated
This commit is contained in:
1 parent
d09b214309
commit
1e99625f3b
1 file changed
+8
@@ -443,6 +443,14 @@ def handle_option(ret: argparse.Namespace, game_weights: dict, option_key: str,
|
||||
|
||||
|
||||
def roll_settings(weights: dict, plando_options: PlandoOptions = PlandoOptions.bosses):
|
||||
"""
|
||||
Roll options from specified weights, usually originating from a .yaml options file.
|
||||
|
||||
Important note:
|
||||
The same weights dict is shared between all slots using the same yaml (e.g. generic weights file for filler slots).
|
||||
This means that it should never be modified without making a copy first.
|
||||
"""
|
||||
|
||||
if "linked_options" in weights:
|
||||
weights = roll_linked_options(weights)
|
||||
|
||||
|
||||
Reference in new issue
Block a user