Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 5 commits into from
Dec 30, 2022
Merged

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

merged 5 commits into from
Dec 30, 2022

Conversation

mathieui
Copy link
Contributor

@mathieui mathieui commented Mar 21, 2021 •
edited by bedevere-bot
Loading

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.

@the-knights-who-say-ni

This comment was marked as outdated.

Sign in to view
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Mar 21, 2021
@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Apr 24, 2021
JelleZijlstra
JelleZijlstra reviewed Apr 3, 2022
View reviewed changes
Copy link
Member

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think documenting a new parameter does need a NEWS entry and bpo link.

Also, the documentation should say what this parameter does.

@github-actions github-actions bot removed the stale Stale PR or inactive for long period of time. label Aug 5, 2022
slateny
slateny reviewed Dec 30, 2022
View reviewed changes
Doc/library/curses.rst Outdated
.. 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*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@slateny slateny changed the title Fix a minor issue in the curses documentation gh-100616: Document 'attr' parameter for window.vline() in curses module Dec 30, 2022
@bedevere-bot bedevere-bot mentioned this pull request Dec 30, 2022
Closed
@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@JelleZijlstra JelleZijlstra added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Dec 30, 2022
@JelleZijlstra JelleZijlstra merged commit f4fcfdf into python:main Dec 30, 2022
@miss-islington
Copy link
Contributor

Thanks @mathieui for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-100625 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Dec 30, 2022
@bedevere-bot
Copy link

GH-100626 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Dec 30, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 30, 2022
@mathieui @slateny @miss-islington
pythongh-100616: Document 'attr' parameter for window.vline() in curs…
0e8c923 
…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>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 30, 2022
@mathieui @slateny @miss-islington
pythongh-100616: Document 'attr' parameter for window.vline() in curs…
af73d8a 
…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>
@JelleZijlstra
Copy link
Member

Thanks @mathieui for the PR and @slateny for finishing it up!

miss-islington added a commit that referenced this pull request Dec 30, 2022
@miss-islington @mathieui @slateny
gh-100616: Document 'attr' parameter for window.vline() in curses mod…
297465a 
…ule (GH-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>
miss-islington added a commit that referenced this pull request Dec 30, 2022
@miss-islington @mathieui @slateny
gh-100616: Document 'attr' parameter for window.vline() in curses mod…
3ab7b61 
…ule (GH-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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra left review comments

@slateny slateny slateny left review comments

Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@mathieui @the-knights-who-say-ni @bedevere-bot @miss-islington @JelleZijlstra @slateny @ezio-melotti