Title: IDLE:Make help source menu entries unique and sorted.
Type: behavior Stage: test needed
Components: IDLE Versions: Python 3.6
Status: open Resolution:
Dependencies: 27380 Superseder:
Assigned To: terry.reedy Nosy List: terry.reedy
Priority: normal Keywords:

Created on 2016-07-08 01:58 by terry.reedy, last changed 2017-06-19 18:44 by terry.reedy.

Messages (2)
msg269965 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2016-07-08 01:58
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".  Issue 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.
msg269966 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2016-07-08 02:10
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.
Date User Action Args
2017-06-19 18:44:12terry.reedysetcomponents: + IDLE
2016-07-08 02:10:03terry.reedysetdependencies: + IDLE: add base Query dialog with ttk widgets
messages: + msg269966
2016-07-08 01:58:46terry.reedycreate