summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2022-12-30 17:05:40 (GMT)
committerGitHub <noreply@github.com>2022-12-30 17:05:40 (GMT)
commit3ab7b61b416b3ce4a01b0566a8d2bec3e3d0e3d4 (patch)
tree200e7c5d9fc6c633b4500a50402ab9f74609c2da
parent2b1cc33db0b413c42393ea3a9b9cdf2c585d804a (diff)
downloadcpython-3ab7b61b416b3ce4a01b0566a8d2bec3e3d0e3d4.zip
cpython-3ab7b61b416b3ce4a01b0566a8d2bec3e3d0e3d4.tar.gz
cpython-3ab7b61b416b3ce4a01b0566a8d2bec3e3d0e3d4.tar.bz2
gh-100616: Document 'attr' parameter for window.vline() in curses module (GH-24961)
(cherry picked from commit f4fcfdf8c593611f98b9358cc0c5604c15306465) Co-authored-by: mathieui <mathieui@users.noreply.github.com> 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 55ab060..5d74b73 100644
--- a/Doc/library/curses.rst
+++ b/Doc/library/curses.rst
@@ -1314,11 +1314,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`.