Merge branch 'main' into dev

Author: Tim-ats-d

setup.py

@@ -12,6 +12,7 @@
     author_email="[email protected]",
     description=__doc__,
     long_description=open("README.md", encoding="utf-8").read(),
+    long_description_content_type="text/markdown",
     install_requires=["windows-curses; platform_system=='Windows'"],
     extras_require={"doc": ["sphinx", "sphinx-rtd-theme"]},
     include_package_data=True,

visualdialog/box.py

@@ -143,8 +143,16 @@ def __init__(
         self.downtime_chars = downtime_chars
         self.downtime_chars_delay = downtime_chars_delay
 
-        self.key_detection: Literal["getkey", "getch", "get_wch"] = "getkey"
+        #: Keystroke acquisition curses method for BaseTextBox.get_input.
+        self.key_detection: Literal["getkey",
+                                    "getch",
+                                    "get_wch"] = "getkey"
+
+        #: List of accepted key to skip dialog.
+        #: This defaults to a list contains ``" "``.
         self.confirm_keys: List[CursesKey] = [" "]
+        #: List of accepted key to raise PanicError.
+        #: This defaults to an empty list.
         self.panic_keys: List[CursesKey] = []
 
     @property

visualdialog/dialog.py

@@ -87,15 +87,13 @@ def __lt__(self, text: str) -> str:
         """A shortcut to call :meth:`char_by_char` by passing only
         `text` argument.
 
-            >>> DialogBox(x, y,
-            ...           height, width,
-            ...           global_win=win) < "Foo bar"
+            >>> db = DialogBox(x, y, height, width, global_win=win)
+            >>> db < "Foo bar"
 
         This code roughly equivalent to:
 
-            >>> DialogBox(x, y,
-            ...           height, width).char_by_char("Foo bar", win)
-
+            >>> db = DialogBox(x, y, height, width)
+            >>> db.char_by_char("Foo bar", win)
         """
         return self.char_by_char(text)