python / cpython

The Python programming language
https://www.python.org
Other
62.21k stars 29.89k forks source link

Tkinter extention modules have no documentation #59551

Open d747b3ef-2d70-47fe-b6e2-8bc88fcaaf37 opened 12 years ago

d747b3ef-2d70-47fe-b6e2-8bc88fcaaf37 commented 12 years ago
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: ```python assignee = None closed_at = None created_at = labels = ['type-feature', 'docs'] title = 'Tkinter extention modules have no documentation' updated_at = user = 'https://bugs.python.org/weirdink13' ``` bugs.python.org fields: ```python activity = actor = 'martin.panter' assignee = 'docs@python' closed = False closed_date = None closer = None components = ['Documentation'] creation = 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'] ```

    d747b3ef-2d70-47fe-b6e2-8bc88fcaaf37 commented 12 years ago

    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.

    d747b3ef-2d70-47fe-b6e2-8bc88fcaaf37 commented 12 years ago

    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.

    d747b3ef-2d70-47fe-b6e2-8bc88fcaaf37 commented 11 years ago

    We could at least put links to some documentation.

    asvetlov commented 11 years ago

    Patch is welcome!

    d747b3ef-2d70-47fe-b6e2-8bc88fcaaf37 commented 11 years ago

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

    terryjreedy commented 8 years ago

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