gh-100616: Document 'attr' parameter for window.vline() in curses module#24961
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
|
This PR is stale because it has been open for 30 days with no activity. |
JelleZijlstra
left a comment
There was a problem hiding this comment.
I think documenting a new parameter does need a NEWS entry and bpo link.
Also, the documentation should say what this parameter does.
Doc/library/curses.rst
Outdated
| window.vline(y, x, ch, n[, attr]) | ||
|
|
||
| Display a vertical line starting at ``(y, x)`` with length *n* consisting of the | ||
| character *ch*. |
There was a problem hiding this comment.
| character *ch*. | |
| character *ch* with attributes *attr*. |
Following wording from https://github.com/python/cpython/blame/894f2c3c161933bd820ad322b3b678d89bc2377c/Doc/library/curses.rst#L710 (also tested and attr does exist, and its values are per the table right under this section.
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
|
Thanks @mathieui for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11. |
|
GH-100625 is a backport of this pull request to the 3.11 branch. |
|
GH-100626 is a backport of this pull request to the 3.10 branch. |
…es module (pythonGH-24961) (cherry picked from commit f4fcfdf) Co-authored-by: mathieui <mathieui@users.noreply.github.com> Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
…es module (pythonGH-24961) (cherry picked from commit f4fcfdf) Co-authored-by: mathieui <mathieui@users.noreply.github.com> Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
This adds the optional "attr" to the documentation, as it has worked since forever and is also present in the tsts, I do not believe this is significant enough to warrant an issue.