Skip to content

Commit e59410a

Browse files
committed
Add doc for words_attr parameter.
1 parent 6c7504f commit e59410a

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

visualdialog/dialog.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,10 @@ def char_by_char(
151151
be a single curses text attribute or a tuple of curses text
152152
attribute. This defaults an empty tuple.
153153
154-
:param words_attr: This defaults to an empty dictionary.
154+
:param words_attr: Dictionary composed of string as a key and a
155+
single curses text attribute or tuple as a value. Each key
156+
is colored with its associated values This defaults to an
157+
empty dictionary.
155158
156159
:param flash_screen: Allows or not to flash screen with a short
157160
light effect done before writing the first character by
@@ -287,7 +290,10 @@ def word_by_word(
287290
be a single curses text attribute or a tuple of curses text
288291
attribute. This defaults an empty tuple.
289292
290-
:param words_attr: This defaults to an empty dictionary.
293+
:param words_attr: Dictionary composed of string as a key and a
294+
single curses text attribute or tuple as a value. Each key
295+
is colored with its associated values This defaults to an
296+
empty dictionary.
291297
292298
:param cut_char: The delimiter according which to split the text
293299
in word. This defaults to ``" "``.

0 commit comments

Comments
 (0)