8000 Fix signature of `_curses.assume_default_colors` in the docs by sobolevn · Pull Request #134409 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Fix signature of _curses.assume_default_colors in the docs #134409

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
Merged
merged 1 commit into from
May 21, 2025
Merged

Fix signature of _curses.assume_default_colors in the docs #134409

merged 1 commit into from
May 21, 2025

Conversation

sobolevn
Copy link
Member
@sobolevn sobolevn commented May 21, 2025 •
edited by github-actions bot
Loading

I think that we should properly document that this function does not accept any keyword args.

>>> import _curses
>>> _curses.assume_default_colors
<built-in function assume_default_colors>
>>> _curses.assume_default_colors(fg=1, bg=2)
Traceback (most recent call last):
  File "<python-input-2>", line 1, in <module>
    _curses.assume_default_colors(fg=1, bg=2)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^
TypeError: _curses.assume_default_colors() takes no keyword arguments

📚 Documentation preview 📚: https://cpython-previews--134409.org.readthedocs.build/

@sobolevn sobolevn requested review from hugovk and AA-Turner May 21, 2025 09:09
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir awaiting core review labels May 21, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs May 21, 2025
@sobolevn sobolevn mentioned this pull request May 21, 2025
Merged
hugovk
hugovk approved these changes May 21, 2025
View reviewed changes
Copy link
Member
@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

👍

https://devguide.python.org/documentation/style-guide/#function-signatures

@hugovk hugovk added needs backport to 3.13 bugs and security fixes and removed awaiting merge needs backport to 3.13 bugs and security fixes labels May 21, 2025
@sobolevn sobolevn merged commit dcfc91e into python:main May 21, 2025
45 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs May 21, 2025
@miss-islington-app
Copy link

Thanks @sobolevn for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 21, 2025
@sobolevn @miss-islington
Fix signature of _curses.assume_default_colors in the docs (pythonG…
7883bff 
…H-134409)

(cherry picked from commit dcfc91e)

Co-authored-by: sobolevn <mail@sobolevn.me>
@bedevere-app
Copy link
bedevere-app bot commented May 21, 2025

GH-134417 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 b 97AD ugs and security fixes label May 21, 2025
sobolevn added a commit that referenced this pull request May 21, 2025
@miss-islington @sobolevn
[3.14] Fix signature of _curses.assume_default_colors in the docs (G…
ac27008 
…H-134409) (#134417)

Fix signature of `_curses.assume_default_colors` in the docs (GH-134409)
(cherry picked from commit dcfc91e)

Co-authored-by: sobolevn <mail@sobolevn.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sobolevn @hugovk
0