monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Make webworld attribute descriptions docstrings instead of comments for nice IDE things (#929)

This commit is contained in:
alwaysintreble 2022-08-22 16:50:16 -05:00 committed by GitHub
parent c695f91198
commit b66a265726
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
worlds/AutoWorld.py
View File

@ -97,22 +97,22 @@ def call_stage(world: "MultiWorld", method_name: str, *args: Any) -> None:
class WebWorld: class WebWorld:
"""Webhost integration""" """Webhost integration"""
# display a settings page. Can be a link to an out-of-ap settings tool too.
settings_page: Union[bool, str] = True settings_page: Union[bool, str] = True
"""display a settings page. Can be a link to a specific page or external tool."""
# docs folder will be scanned for game info pages using this list in the format '{language}_{game_name}.md'
game_info_languages: List[str] = ['en'] 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"] 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" 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] 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): class World(metaclass=AutoWorldRegister):