From b66a2657261dadc897f2f70cba2f49f70f20f0fc Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Mon, 22 Aug 2022 16:50:16 -0500 Subject: [PATCH] Docs: Make webworld attribute descriptions docstrings instead of comments for nice IDE things (#929) --- worlds/AutoWorld.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/worlds/AutoWorld.py b/worlds/AutoWorld.py index 1ca5b534..02b94c5f 100644 --- a/worlds/AutoWorld.py +++ b/worlds/AutoWorld.py @@ -97,22 +97,22 @@ def call_stage(world: "MultiWorld", method_name: str, *args: Any) -> None: class WebWorld: """Webhost integration""" - # display a settings page. Can be a link to an out-of-ap settings tool too. + settings_page: Union[bool, str] = True - - # docs folder will be scanned for game info pages using this list in the format '{language}_{game_name}.md' + """display a settings page. Can be a link to a specific page or external tool.""" + game_info_languages: List[str] = ['en'] + """docs folder will be scanned for game info pages using this list in the format '{language}_{game_name}.md'""" - # docs folder will also be scanned for tutorial guides given the relevant information in this list. Each Tutorial - # class is to be used for one guide. tutorials: List["Tutorial"] + """docs folder will also be scanned for tutorial guides. Each Tutorial class is to be used for one guide.""" - # Choose a theme for your /game/* pages - # Available: dirt, grass, grassFlowers, ice, jungle, ocean, partyTime, stone theme = "grass" + """Choose a theme for you /game/* pages. + Available: dirt, grass, grassFlowers, ice, jungle, ocean, partyTime, stone""" - # display a link to a bug report page, most likely a link to a GitHub issue page. bug_report_page: Optional[str] + """display a link to a bug report page, most likely a link to a GitHub issue page.""" class World(metaclass=AutoWorldRegister):