From 9928639ce2c64414fd1a96a1d85d63d33d70e073 Mon Sep 17 00:00:00 2001 From: qwint Date: Sun, 12 Jan 2025 11:01:42 -0500 Subject: [PATCH] Docs: Fix Typo in Rich Text Options Flag Documentation (#4462) --- Options.py | 2 +- docs/options api.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Options.py b/Options.py index f4724e97..135a1dcb 100644 --- a/Options.py +++ b/Options.py @@ -137,7 +137,7 @@ class Option(typing.Generic[T], metaclass=AssembleOptions): If this is False, the docstring is instead interpreted as plain text, and displayed as-is on the WebHost with whitespace preserved. - If this is None, it inherits the value of `World.rich_text_options_doc`. For + If this is None, it inherits the value of `WebWorld.rich_text_options_doc`. For backwards compatibility, this defaults to False, but worlds are encouraged to set it to True and use reStructuredText for their Option documentation. diff --git a/docs/options api.md b/docs/options api.md index d48a56d6..453cbc7e 100644 --- a/docs/options api.md +++ b/docs/options api.md @@ -95,7 +95,7 @@ user hovers over the yellow "(?)" icon, and included in the YAML templates gener The WebHost can display Option documentation either as plain text with all whitespace preserved (other than the base indentation), or as HTML generated from the standard Python [reStructuredText] format. Although plain text is the default for backwards compatibility, world authors are encouraged to write their Option documentation as -reStructuredText and enable rich text rendering by setting `World.rich_text_options_doc = True`. +reStructuredText and enable rich text rendering by setting `WebWorld.rich_text_options_doc = True`. [reStructuredText]: https://docutils.sourceforge.io/rst.html