Demo/comparisons/regextest.py needs some usage information.

[ramiroluz]

BPO	10494
Nosy	@birkenfeld, @abalkin, @merwok
Files	issue10494_demo_regextest_usage_patch.diff issue10494_demo_regextest_usage_patch_v2.diff

^{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 = <Date 2010-12-30.22:36:07.231>
created_at = <Date 2010-11-22.00:09:54.423>
labels = ['type-feature']
title = 'Demo/comparisons/regextest.py needs some usage information.'
updated_at = <Date 2010-12-30.22:36:07.230>
user = 'https://bugs.python.org/ramiroluz'

bugs.python.org fields:

activity = <Date 2010-12-30.22:36:07.230>
actor = 'georg.brandl'
assignee = 'none'
closed = True
closed_date = <Date 2010-12-30.22:36:07.231>
closer = 'georg.brandl'
components = ['Demos and Tools']
creation = <Date 2010-11-22.00:09:54.423>
creator = 'ramiroluz'
dependencies = []
files = ['19759', '19761']
hgrepos = []
issue_num = 10494
keywords = ['patch']
message_count = 6.0
messages = ['122032', '122035', '122047', '122049', '122052', '124941']
nosy_count = 4.0
nosy_names = ['georg.brandl', 'belopolsky', 'eric.araujo', 'ramiroluz']
pr_nums = []
priority = 'normal'
resolution = 'out of date'
stage = 'patch review'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue10494'
versions = ['Python 3.2']

[ramiroluz]

When someone run Demo/comparisons/regextest.py without arguments it waits for lines to be inserted in the command line silently, until the EOF, or Ctrl-D in Linux, is entered.

If the user read the file, editing or using cat Demo/comparisons/regextest.py he have to understand the code to figure out how to use it.

My suggestion is to add an usage message.

[ramiroluz]

Suggested patch.

[abalkin]

+0

Not "+1" because Georg suggested that this demo be removed. See

http://mail.python.org/pipermail/python-ideas/2010-October/008416.html

On the patch, I would define a "usage" variable near the top of the program instead of repeating the usage text in the comment.

[merwok]

Beware of UUOC: http://en.wikipedia.org/wiki/Cat_%28Unix%29#Useless_use_of_cat

[ramiroluz]

New patch from the suggestions, probably it will be discarded (see http://mail.python.org/pipermail/python-ideas/2010-October/008416.html)

But the work was already done. :P

[birkenfeld]

Demo/comparisons has now been removed.