From: Jay Crotts Date: Sat, 7 Apr 2018 01:27:07 +0000 (-0500) Subject: bpo-8243: Doc patch for curses.window.addstr and curses.window.addch (GH-5179) X-Git-Tag: v3.8.0a1~1987 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ef5ce884a41c8553a7eff66ebace908c1dcc1f89;p=thirdparty%2FPython%2Fcpython.git bpo-8243: Doc patch for curses.window.addstr and curses.window.addch (GH-5179) --- diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst index 13717f7b35e6..2a2ee2be84af 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) diff --git a/Misc/NEWS.d/next/Documentation/2018-01-13-20-30-53.bpo-8243.s98r28.rst b/Misc/NEWS.d/next/Documentation/2018-01-13-20-30-53.bpo-8243.s98r28.rst new file mode 100644 index 000000000000..a3520d05c095 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2018-01-13-20-30-53.bpo-8243.s98r28.rst @@ -0,0 +1,2 @@ +Add a note about curses.addch and curses.addstr exception behavior when +writing outside a window, or pad.