]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-100616: Document 'attr' parameter for window.vline() in curses module (GH-24961)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 30 Dec 2022 17:05:49 +0000 (09:05 -0800)
committerGitHub <noreply@github.com>
Fri, 30 Dec 2022 17:05:49 +0000 (09:05 -0800)
(cherry picked from commit f4fcfdf8c593611f98b9358cc0c5604c15306465)

Co-authored-by: mathieui <mathieui@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Doc/library/curses.rst
Misc/NEWS.d/next/Documentation/2022-12-30-00-42-23.gh-issue-100616.eu80ij.rst [new file with mode: 0644]

index 9b2c3fbd8e4ee361096911679ca8228ec863f958..56311033d6316392ee1ca55d407ba16a668969a4 100644 (file)
@@ -1300,11 +1300,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 (file)
index 0000000..97a7022
--- /dev/null
@@ -0,0 +1,2 @@
+Document existing ``attr`` parameter to :func:`curses.window.vline` function
+in :mod:`curses`.