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

Tkinter extention modules have no documentation #59551

Open
weirdink13 mannequin opened this issue Jul 13, 2012 · 6 comments
Open

Tkinter extention modules have no documentation #59551

weirdink13 mannequin opened this issue Jul 13, 2012 · 6 comments
Labels
docs Documentation in the Doc dir topic-tkinter type-feature A feature request or enhancement

Comments

@weirdink13
Copy link
Mannequin

weirdink13 mannequin commented Jul 13, 2012

BPO 15346
Nosy @terryjreedy, @asvetlov
Dependencies
  • bpo-25237: Add doc for tkinter commondialog.Dialog and subclasses
  • bpo-30210: No Documentation on tkinter dnd module
  • 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 = None
    created_at = <Date 2012-07-13.16:47:26.634>
    labels = ['type-feature', 'docs']
    title = 'Tkinter extention modules have no documentation'
    updated_at = <Date 2017-04-30.12:05:43.514>
    user = 'https://bugs.python.org/weirdink13'

    bugs.python.org fields:

    activity = <Date 2017-04-30.12:05:43.514>
    actor = 'martin.panter'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2012-07-13.16:47:26.634>
    creator = 'weirdink13'
    dependencies = ['25237', '30210']
    files = []
    hgrepos = []
    issue_num = 15346
    keywords = []
    message_count = 6.0
    messages = ['165392', '168316', '176966', '176973', '177045', '251631']
    nosy_count = 4.0
    nosy_names = ['terry.reedy', 'asvetlov', 'docs@python', 'weirdink13']
    pr_nums = []
    priority = 'normal'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue15346'
    versions = ['Python 2.7', 'Python 3.5', 'Python 3.6']

    @weirdink13
    Copy link
    Mannequin Author

    weirdink13 mannequin commented Jul 13, 2012

    The title should be self explanatory.
    I needed Drag-and-drop for a project I was working on, (maybe I shouldn't be refering to it in the past tense as I haven't started yet) so I checked the documentation for tkinter and found:
    3.3.0 b1
    tkinter.dnd
    Drag-and-drop support for tkinter. This is experimental and should become deprecated when it is replaced with the Tk DND.

    3.2.2 (and .2.3)
    tkinter.dnd
    Drag-and-drop support for tkinter. This is experimental and should become deprecated when it is replaced with the Tk DND.

    2.7.3
    Tkdnd
    Drag-and-drop support for Tkinter. This is experimental and should become deprecated when it is replaced with the Tk DND.

    I think that tkinter.dnd needs some documentation, whether or not it is replaced with Tk DND.

    @weirdink13 weirdink13 mannequin assigned docspython Jul 13, 2012
    @weirdink13 weirdink13 mannequin added the docs Documentation in the Doc dir label Jul 13, 2012
    @weirdink13
    Copy link
    Mannequin Author

    weirdink13 mannequin commented Aug 15, 2012

    For that matter, none of the following have docs:
    tkinter.colorchooser
    tkinter.commondialog
    tkinter.filedialog
    tkinter.font
    tkinter.messagebox
    tkinter.simpledialog
    tkinter.dnd
    Perhaps this should be remidied? One sentence usualy does not describe the use of an entire module.

    @weirdink13 weirdink13 mannequin changed the title Tkinter dnd has no documentation Tkinter extention modules no documentation Aug 15, 2012
    @weirdink13 weirdink13 mannequin added the type-feature A feature request or enhancement label Aug 15, 2012
    @weirdink13 weirdink13 mannequin changed the title Tkinter extention modules no documentation Tkinter extention modules have no documentation Aug 15, 2012
    @weirdink13 weirdink13 mannequin added stale Stale PR or inactive for long period of time. and removed stale Stale PR or inactive for long period of time. labels Nov 16, 2012
    @weirdink13
    Copy link
    Mannequin Author

    weirdink13 mannequin commented Dec 5, 2012

    We could at least put links to some documentation.

    @asvetlov
    Copy link
    Contributor

    asvetlov commented Dec 5, 2012

    Patch is welcome!

    @weirdink13
    Copy link
    Mannequin Author

    weirdink13 mannequin commented Dec 6, 2012

    There is documentation of these modules, it's just that it's in the modules themselves.

    @terryjreedy
    Copy link
    Member

    I opened bpo-25237 for commondialog, messagebox, and colorchooser.

    @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
    Labels
    docs Documentation in the Doc dir topic-tkinter type-feature A feature request or enhancement
    Projects
    None yet
    Development

    No branches or pull requests

    3 participants