classification
Title: IDLE: revise zzdummy.py
Type: behavior Stage: patch review
Components: IDLE Versions: Python 3.7, Python 3.6
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: terry.reedy
Priority: normal Keywords: patch

Created on 2018-01-23 06:57 by terry.reedy, last changed 2019-07-01 00:45 by cheryl.sabella.

Pull Requests
URL Status Linked Edit
PR 14491 open cheryl.sabella, 2019-07-01 00:45
Messages (1)
msg310473 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2018-01-23 06:57
zzdummy.py is needed for properly testing the extension mechanism.  It is intended to provide an example extension for users to follow.  When completed, enabled, and invoked, it will prefix every line of a window with some text, or remove the prefix from every line.  It would be even better to make it respect selections, as other format options do.

Needed: more comments, including what it does when enabled; docstring for z_in_event; uncomment z_in_event; code for z_out_event.

Should the extension have a different name? ZzTestExample? ZzIgnoreThis?  Changing an extension name would normally be a bad idea, as it would disable any customizations.  But I think we could do it for this one if desired.

The default insertion text could be more informative: for instance, 'ignore this' or 'see-doc' or #ignore#.  The last would make it a configurable comment/uncomment.  Normally, changing a default is a no-no, as it can mess up user configurations.  But since the current text is inoperative, this should not matter here.

The menu defs are commented out because enabling the extension currently has no effect, so the menu entries would be useless.

***There should be help text for the extension tab explaining the presence and operation of the extension.  (This should have  been done already.)

Extension tests, last revised in #31480, will likely need more changes.
History
Date User Action Args
2019-07-01 00:45:28cheryl.sabellasetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request14308
2018-01-23 06:57:24terry.reedycreate