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.

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

IDLE:Make help source menu entries unique and sorted. #71652

Open
terryjreedy opened this issue Jul 8, 2016 · 5 comments
Open

IDLE:Make help source menu entries unique and sorted. #71652

terryjreedy opened this issue Jul 8, 2016 · 5 comments
Assignees
@terryjreedy
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes topic-IDLE type-bug An unexpected behavior, bug, or error

Comments

@terryjreedy
Copy link
Member

BPO 27465
Nosy @terryjreedy, @taleinat, @csabella, @ZackerySpytz
PRs
  • gh-71652: Make IDLE help source menu entries unique and sorted #17093
    		•
    Dependencies
  • bpo-27380: IDLE: add base Query dialog with ttk widgets
    		•

    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 = 'https://github.com/terryjreedy'
closed_at = None
created_at = <Date 2016-07-08.01:58:45.959>
labels = ['3.8', 'expert-IDLE', 'type-bug', '3.7', '3.9']
title = 'IDLE:Make help source menu entries unique and sorted.'
updated_at = <Date 2019-11-14.13:30:37.183>
user = 'https://github.com/terryjreedy'

    bugs.python.org fields:

    activity = <Date 2019-11-14.13:30:37.183>
actor = 'taleinat'
assignee = 'terry.reedy'
closed = False
closed_date = None
closer = None
components = ['IDLE']
creation = <Date 2016-07-08.01:58:45.959>
creator = 'terry.reedy'
dependencies = ['27380']
files = []
hgrepos = []
issue_num = 27465
keywords = ['patch']
message_count = 5.0
messages = ['269965', '269966', '316296', '356274', '356606']
nosy_count = 4.0
nosy_names = ['terry.reedy', 'taleinat', 'cheryl.sabella', 'ZackerySpytz']
pr_nums = ['17093']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue27465'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']
    @terryjreedy
    Copy link
    Member Author

    The 'General' tab of the IDLE configuration menu allows a user to add entries to the Help menu that display a text when clicked. A user might want more than one text available for a given 'topic', such as a doc and how-to for a package. However, there is no need to have duplicate entries, as up to 30 chars are allowed. "Package - doc" and "Package - how" would be clearer than "Package" and "Package". bpo-27380 makes checking for unique entries easy as that is already done for user configuration file section names and the same base class is now used for help source names.

    Currently, names are displayed in the order added. I believe sorting would be better, especially when one adds more than 2 entries. That should also be easy.

    Existing duplicates would not be a problem for IDLE as the check would only apply when adding or editing an item. Python's stable list.sort would keep existing duplicates in the same relative order. I will *not* use the doc path to break ties.

    @terryjreedy terryjreedy self-assigned this Jul 8, 2016
    @terryjreedy terryjreedy added the type-bug An unexpected behavior, bug, or error label Jul 8, 2016
    @terryjreedy
    Copy link
    Member Author

    The IDLE doc currently says "Additional help sources may be added here with the Configure IDLE dialog under the General tab." Revise to something like

    Additional help sources
    Menu items for display here are added on the General tap of Options => Configure IDLE. Menu entries should be unique (new in 3.6) and will be sorted. Documents can be located either on the current machine or on the internet. The allowed file types may depend on the system. Local file paths are checked when submitted; internet addresses are not.

    @csabella
    Copy link
    Contributor

    csabella commented May 8, 2018

    Currently, names are displayed in the order added. I believe sorting would be better, especially when one adds more than 2 entries. That should also be easy.

    I'm wondering if it would be worthwhile to add Drag and Drop functionality to the Help listbox to allow users to move the items into any order they want?

    @ZackerySpytz
    Copy link
    Mannequin

    ZackerySpytz mannequin commented Nov 8, 2019

    I have created a pull request for this issue. Please consider taking a look.

    @taleinat
    Copy link
    Contributor

    I'm wondering if it would be worthwhile to add Drag and Drop functionality to the Help listbox to allow users to move the items into any order they want?

    I agree that allowing a user to set the order is preferable.

    Rather than drag&drop, we could just add up/down buttons to allow re-ordering.

    I suggest making ordering a separate issue, and accepting a simplified version of the PR which just ensures the names are unique.

    @taleinat taleinat added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes labels Nov 14, 2019
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @bedevere-bot bedevere-bot mentioned this issue Jan 7, 2023
    Open
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @terryjreedy terryjreedy

    Labels
    3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes topic-IDLE type-bug An unexpected behavior, bug, or error
    Projects
    IDLE Issues
    Status: In Progress
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @taleinat @terryjreedy @csabella