summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormathieui <mathieui@users.noreply.github.com>2022-12-30 16:35:04 (GMT)
committerGitHub <noreply@github.com>2022-12-30 16:35:04 (GMT)
commitf4fcfdf8c593611f98b9358cc0c5604c15306465 (patch)
treef19873a38d8d993467cbe6c1c7885e60682b072c
parent79c10b7da84f52999dc483fc62c8e758ad3eff23 (diff)
downloadcpython-f4fcfdf8c593611f98b9358cc0c5604c15306465.zip
cpython-f4fcfdf8c593611f98b9358cc0c5604c15306465.tar.gz
cpython-f4fcfdf8c593611f98b9358cc0c5604c15306465.tar.bz2
gh-100616: Document 'attr' parameter for window.vline() in curses module (#24961)
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
-rw-r--r--Doc/library/curses.rst6
-rw-r--r--Misc/NEWS.d/next/Documentation/2022-12-30-00-42-23.gh-issue-100616.eu80ij.rst2
2 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst
index f9f94b2..f50b51c 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 0000000..97a7022
--- /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`.