[Python-checkins] gh-100616: Document 'attr' parameter for window.vline() in curses module (#24961)

JelleZijlstra webhook-mailer at python.org
Fri Dec 30 11:35:31 EST 2022


https://github.com/python/cpython/commit/f4fcfdf8c593611f98b9358cc0c5604c15306465
commit: f4fcfdf8c593611f98b9358cc0c5604c15306465
branch: main
author: mathieui <mathieui at users.noreply.github.com>
committer: JelleZijlstra <jelle.zijlstra at gmail.com>
date: 2022-12-30T08:35:04-08:00
summary:

gh-100616: Document 'attr' parameter for window.vline() in curses module (#24961)

Co-authored-by: Stanley <46876382+slateny at users.noreply.github.com>

files:
A Misc/NEWS.d/next/Documentation/2022-12-30-00-42-23.gh-issue-100616.eu80ij.rst
M Doc/library/curses.rst

diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst
index f9f94b22f69e..f50b51c3780e 100644
--- a/Doc/library/curses.rst
+++ b/Doc/library/curses.rst
@@ -1297,11 +1297,11 @@ the following methods and attributes:
    :meth:`refresh`.
 
 
-.. method:: window.vline(ch, n)
-            window.vline(y, x, ch, n)
+.. method:: window.vline(ch, n[, attr])
+            window.vline(y, x, ch, n[, attr])
 
    Display a vertical line starting at ``(y, x)`` with length *n* consisting of the
-   character *ch*.
+   character *ch* with attributes *attr*.
 
 
 Constants
diff --git a/Misc/NEWS.d/next/Documentation/2022-12-30-00-42-23.gh-issue-100616.eu80ij.rst b/Misc/NEWS.d/next/Documentation/2022-12-30-00-42-23.gh-issue-100616.eu80ij.rst
new file mode 100644
index 000000000000..97a7022c94b4
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2022-12-30-00-42-23.gh-issue-100616.eu80ij.rst
@@ -0,0 +1,2 @@
+Document existing ``attr`` parameter to :func:`curses.window.vline` function
+in :mod:`curses`.



More information about the Python-checkins mailing list