Skip to content

Commit 3fd2355

Browse files
committed
Fix in doc, add a parameter in setup.py.
1 parent 6bdb3b7 commit 3fd2355

File tree

3 files changed

+3
-14
lines changed

3 files changed

+3
-14
lines changed

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
author_email="[email protected]",
1313
description=__doc__,
1414
long_description=open("README.md", encoding="utf-8").read(),
15+
long_description_content_type="text/markdown",
1516
install_requires=["windows-curses; platform_system=='Windows'"],
1617
extras_require={"doc": ["sphinx", "sphinx-rtd-theme"]},
1718
include_package_data=True,

visualdialog/box.py

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ def __init__(
108108
self.downtime_chars_delay = downtime_chars_delay
109109

110110
#: Keystroke acquisition curses method for BaseTextBox.get_input.
111+
#: See https://docs.python.org/3/library/curses.html?#curses.window.getch
111112
self.key_detection: Literal["getkey",
112113
"getch",
113114
"get_wch"] = "getkey"
@@ -175,25 +176,13 @@ def get_input(self, win: CursesWindow):
175176
``self.confirm_keys`` is not detected.
176177
177178
The method of key detection depends on the variable
178-
``self.key_detection_mode``. ``"key"`` will acquire the key as
179-
a character and ``"code"`` as a key code. This is default to
180-
``"key"``.
179+
``self.key_detection``.
181180
182181
:param win: ``curses`` window object on which the method will
183182
have effect.
184183
185184
:raises PanicError: If a key contained in ``self.panic_keys`` is
186185
pressed.
187-
188-
.. NOTE::
189-
- This method uses ``window.getch`` method from ``curses``
190-
module. Please refer to `curses documentation
191-
<https://docs.python.org/3/library/curses.html?#curses.window.getch>`_
192-
for more informations.
193-
- This method uses ``window.getkey`` method from ``curses``
194-
module. Please refer to `curses documentation
195-
<https://docs.python.org/3/library/curses.html?#curses.window.getkey>`_
196-
for more informations.
197186
"""
198187
curses.flushinp()
199188

visualdialog/dialog.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,6 @@ def _one_by_one(self,
180180
attr = (colors_pair, *text_attr)
181181

182182
with TextAttr(win, *attr):
183-
write_method = getattr(self, write_method.__name__)
184183
write_method(win,
185184
self.text_pos_x + offsetting_x,
186185
self.text_pos_y + y,

0 commit comments

Comments
 (0)