◐ Shell
reader mode source ↗
Skip to content

gh-126008: Improve docstrings for Tkinter cget and configure methods#133303

Merged
serhiy-storchaka merged 5 commits into
python:mainfrom
serhiy-storchaka:docs-tkinter-configure
Aug 12, 2025
Merged

gh-126008: Improve docstrings for Tkinter cget and configure methods#133303
serhiy-storchaka merged 5 commits into
python:mainfrom
serhiy-storchaka:docs-tkinter-configure

Conversation

@serhiy-storchaka

@serhiy-storchaka serhiy-storchaka commented May 2, 2025 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member
  • Explain the behavior of Widget.configure() depending on arguments.
  • Unify descriptions.
  • Replace "resource" with "option".

@serhiy-storchaka
pythongh-126008: Improve docstrings for Tkinter cget and configure me… …
c7f9234 
…thods

* Explain the behavior of Widget.configure() depending on arguments.
* Unify descriptions.
* Replace "resource" with "option".
@serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir skip news needs backport to 3.13 bugs and security fixes labels May 2, 2025
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs May 2, 2025
@bedevere-app bedevere-app Bot mentioned this pull request May 2, 2025
Closed
@bedevere-app

bedevere-app Bot commented May 3, 2025

Copy link
Copy Markdown

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

@serhiy-storchaka serhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
@serhiy-storchaka serhiy-storchaka requested a review from a team May 13, 2025 10:36
@terryjreedy terryjreedy dismissed their stale review August 11, 2025 21:21

We agree that it would be better to have a separate issue/PR to handle option name formatting in docstrings in this entire file.

Hide details View details @serhiy-storchaka serhiy-storchaka merged commit 027cacb into python:main Aug 12, 2025
43 of 44 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Aug 12, 2025
@miss-islington-app

miss-islington-app Bot commented Aug 12, 2025

Copy link
Copy Markdown

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@serhiy-storchaka serhiy-storchaka deleted the docs-tkinter-configure branch August 12, 2025 04:55
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 12, 2025
@serhiy-storchaka @miss-islington
pythongh-126008: Improve docstrings for Tkinter cget and configure me… …
12f491a 
…thods (pythonGH-133303)

* Explain the behavior of Widget.configure() depending on arguments.
* Unify descriptions.
* Replace "resource" with "option".
(cherry picked from commit 027cacb)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 12, 2025
@serhiy-storchaka @miss-islington
pythongh-126008: Improve docstrings for Tkinter cget and configure me… …
b2568e8 
…thods (pythonGH-133303)

* Explain the behavior of Widget.configure() depending on arguments.
* Unify descriptions.
* Replace "resource" with "option".
(cherry picked from commit 027cacb)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app

bedevere-app Bot commented Aug 12, 2025

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Aug 12, 2025
@bedevere-app

bedevere-app Bot commented Aug 12, 2025

Copy link
Copy Markdown

GH-137661 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Aug 12, 2025
serhiy-storchaka added a commit that referenced this pull request Aug 12, 2025
@miss-islington @serhiy-storchaka
[3.13] gh-126008: Improve docstrings for Tkinter cget and configure m… …
4a630d7 
…ethods (GH-133303) (GH-137661)

* Explain the behavior of Widget.configure() depending on arguments.
* Unify descriptions.
* Replace "resource" with "option".
(cherry picked from commit 027cacb)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@serhiy-storchaka

serhiy-storchaka commented Aug 12, 2025

Copy link
Copy Markdown
Member Author

Thank you for your review, @terryjreedy, @bskinn.

maurycy added a commit to maurycy/cpython that referenced this pull request Aug 12, 2025
@maurycy
Merge branch 'main' into csv-sniffer-counter-set …
11c891d 
* main:
  pythongh-137288: Update 3.14 magic numbers (pythonGH-137665)
  pythongh-135228: When @DataClass(slots=True) replaces a dataclass, make the original class collectible (take 2) (pythonGH-137047)
  pythongh-126008: Improve docstrings for Tkinter cget and configure methods (pythonGH-133303)
  pythongh-131885: Use positional-only markers for ``max()`` and ``min()`` (python#131868)
  pythonGH-137426: Remove code deprecation of `importlib.abc.ResourceLoader` (pythonGH-137567)
  pythongh-125897: Mark range function parameters as positional only (python#125945)
  pythongh-137400: Fix a crash when disabling profiling across all threads (pythongh-137471)
  pythongh-115766: Fix IPv4Interface.is_unspecified (pythonGH-137326)
  pythongh-128813: cleanup C-API docs for PyComplexObject (pythonGH-137579)
  pythongh-135953: Profile a module or script with sampling profiler (python#136777)
  Fix documentation of hash in PyHash_FuncDef (python#137595)
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@serhiy-storchaka @Agent-Hellboy
pythongh-126008: Improve docstrings for Tkinter cget and configure me… …
d7253bd 
…thods (pythonGH-133303)

* Explain the behavior of Widget.configure() depending on arguments.
* Unify descriptions.
* Replace "resource" with "option".
encukou pushed a commit that referenced this pull request Oct 7, 2025
@miss-islington @serhiy-storchaka
[3.14] gh-126008: Improve docstrings for Tkinter cget and configure m… …
181cecc 
…ethods (GH-133303) (GH-137660)

* Explain the behavior of Widget.configure() depending on arguments.
* Unify descriptions.
* Replace "resource" with "option".
(cherry picked from commit 027cacb)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tomasr8 tomasr8 tomasr8 left review comments

@AA-Turner AA-Turner

@terryjreedy terryjreedy terryjreedy left review comments

+1 more reviewer

@bskinn bskinn bskinn left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@serhiy-storchaka @tomasr8 @AA-Turner @bskinn @terryjreedy