summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorJay Crotts <crotts.jay@gmail.com>2018-04-07 01:27:07 (GMT)
committerNed Deily <nad@python.org>2018-04-07 01:27:07 (GMT)
commitef5ce884a41c8553a7eff66ebace908c1dcc1f89 (patch)
tree268d4ae444914e210c5edf487e86de12afecbf1d /Doc
parent9e2be60634914f23db2ae5624e4acc9335bf5fea (diff)
downloadcpython-ef5ce884a41c8553a7eff66ebace908c1dcc1f89.zip
cpython-ef5ce884a41c8553a7eff66ebace908c1dcc1f89.tar.gz
cpython-ef5ce884a41c8553a7eff66ebace908c1dcc1f89.tar.bz2
bpo-8243: Doc patch for curses.window.addstr and curses.window.addch (GH-5179)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/curses.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst
index 13717f7..2a2ee2b 100644
--- a/Doc/library/curses.rst
+++ b/Doc/library/curses.rst
@@ -685,6 +685,12 @@ the following methods and attributes:
character previously painter at that location. By default, the character
position and attributes are the current settings for the window object.
+ .. note::
+
+ Writing outside the window, subwindow, or pad raises a :exc:`curses.error`.
+ Attempting to write to the lower right corner of a window, subwindow,
+ or pad will cause an exception to be raised after the character is printed.
+
.. method:: window.addnstr(str, n[, attr])
window.addnstr(y, x, str, n[, attr])
@@ -700,6 +706,12 @@ the following methods and attributes:
Paint the character string *str* at ``(y, x)`` with attributes
*attr*, overwriting anything previously on the display.
+ .. note::
+
+ Writing outside the window, subwindow, or pad raises :exc:`curses.error`.
+ Attempting to write to the lower right corner of a window, subwindow,
+ or pad will cause an exception to be raised after the string is printed.
+
.. method:: window.attroff(attr)