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.

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

Add doc for tkinter commondialog.Dialog and subclasses #69424

Closed
terryjreedy opened this issue Sep 26, 2015 · 5 comments
Closed

Add doc for tkinter commondialog.Dialog and subclasses #69424

terryjreedy opened this issue Sep 26, 2015 · 5 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@terryjreedy
Copy link
Member

BPO 25237
Nosy @terryjreedy, @serhiy-storchaka, @JulienPalard, @patel-nikhil
PRs
  • bpo-25237: Documentation for tkinter modules #1870
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2019-09-10.08:56:16.581>
created_at = <Date 2015-09-26.03:03:32.702>
labels = ['type-feature', 'docs']
title = 'Add doc for tkinter commondialog.Dialog and subclasses'
updated_at = <Date 2019-09-10.08:56:16.580>
user = 'https://github.com/terryjreedy'

    bugs.python.org fields:

    activity = <Date 2019-09-10.08:56:16.580>
actor = 'mdk'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-09-10.08:56:16.581>
closer = 'mdk'
components = ['Documentation']
creation = <Date 2015-09-26.03:03:32.702>
creator = 'terry.reedy'
dependencies = []
files = []
hgrepos = []
issue_num = 25237
keywords = []
message_count = 5.0
messages = ['251630', '251633', '294788', '318506', '351593']
nosy_count = 5.0
nosy_names = ['terry.reedy', 'docs@python', 'serhiy.storchaka', 'mdk', 'npatel']
pr_nums = ['1870']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue25237'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6']
    @terryjreedy
    Copy link
    Member Author

    As noted in bpo-15346, several modules are not documented except in the code. Having just had to do that for bpo-25173, I would like there to be a page for commondialog.Dialog and its subclasses, messagebox.Message and colorchooser.Chooser, and the associated module functions. I hope to submit a .rst file for review if no one else does so. My plan is to copy from web pages produced by the pydoc server, add markup, and edit.

    @terryjreedy terryjreedy added the type-feature A feature request or enhancement label Sep 26, 2015
    @terryjreedy
    Copy link
    Member Author

    Side issue: Dialog has this:
    # we need a dummy widget to properly process the options
    # (at least as long as we use Tkinter 1.63)
    w = Frame(self.master)

    Do you know what 'Tkinter 1.63' refers to? In 2.7, Tkinter.__version__ is '$Revision: 81008 $'. If self.master is not None, I would expect that it can be used in
    s = w.tk.call(self.command, *w._options(self.options))
    s = self._fixresult(w, s)

    @patel-nikhil
    Copy link
    Mannequin

    patel-nikhil mannequin commented May 30, 2017

    I've written rst files containing documentation for the tkinter modules and submitted a PR. Attempted to mimic the wording as well as style of existing documentation to keep it consistent.

    @patel-nikhil
    Copy link
    Mannequin

    patel-nikhil mannequin commented Jun 2, 2018

    PR to add documentation still up-to-date and all checks successful just pending review

    @patel-nikhil patel-nikhil mannequin added the docs Documentation in the Doc dir label Jun 2, 2018
    @patel-nikhil patel-nikhil mannequin assigned docspython Jun 2, 2018
    @JulienPalard
    Copy link
    Member

    New changeset 80428ed by Julien Palard (Nikhil) in branch 'master':
    bpo-25237: Documentation for tkinter modules (GH-1870)
    80428ed

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @JulienPalard @terryjreedy