From 29ba1d4809b1aa9a5e5ee2b994bc80bcdc38eb24 Mon Sep 17 00:00:00 2001 From: black-sliver <59490463+black-sliver@users.noreply.github.com> Date: Wed, 2 Feb 2022 23:33:26 +0100 Subject: [PATCH] Doc: change displayname to display_name in api.md --- docs/api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api.md b/docs/api.md index f49cad33..082a7c01 100644 --- a/docs/api.md +++ b/docs/api.md @@ -217,7 +217,7 @@ By convention options are defined in `Options.py` and will be used when parsing the players' yaml files. Each option has its own class, inherits from a base option type, has a docstring -to describe it and a `displayname` property for display on the website and in +to describe it and a `display_name` property for display on the website and in spoiler logs. The actual name as used in the yaml is defined in a `dict[str, Option]`, that is @@ -263,7 +263,7 @@ import typing class Difficulty(Choice): """Sets overall game difficulty.""" - displayname = "Difficulty" + display_name = "Difficulty" option_easy = 0 option_normal = 1 option_hard = 2 @@ -273,14 +273,14 @@ class Difficulty(Choice): class FinalBossHP(Range): """Sets the HP of the final boss""" - displayname = "Final Boss HP" + display_name = "Final Boss HP" range_start = 100 range_end = 10000 default = 2000 class FixXYZGlitch(Toggle): """Fixes ABC when you do XYZ""" - displayname = "Fix XYZ Glitch" + display_name = "Fix XYZ Glitch" # By convention we call the options dict variable `_options`. mygame_options: typing.Dict[str, type(Option)] = {