bpo-8243: Doc patch for curses.window.addstr and curses.window.addch (GH-5179)

This commit is contained in:
Jay Crotts 2018-04-06 20:27:07 -05:00 committed by Ned Deily
parent 9e2be60634
commit ef5ce884a4
2 changed files with 14 additions and 0 deletions

View File

@ -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)

View File

@ -0,0 +1,2 @@
Add a note about curses.addch and curses.addstr exception behavior when
writing outside a window, or pad.