Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > comp.lang.python > #107994

Re: What should Python apps do when asked to show help?

Path csiph.com!fu-berlin.de!uni-berlin.de!not-for-mail
From Terry Reedy <tjreedy@udel.edu>
Newsgroups comp.lang.python
Subject Re: What should Python apps do when asked to show help?
Date Mon, 2 May 2016 02:34:13 -0400
Lines 36
Message-ID <mailman.309.1462170863.32212.python-list@python.org> (permalink)
References <1462074388.273747.594588777.5E705539@webmail.messagingengine.com> <20160501052434.GA98660@cskk.homeip.net> <CAPTjJmr5E8zGB6Q0WWaja1DkZqac0SVm2X5eXOvYvd4YE3vZCg@mail.gmail.com> <ng51p3$c81$1@ger.gmane.org> <mailman.283.1462110832.32212.python-list@python.org> <87r3dlolx6.fsf@elektro.pacujo.net> <ng5aub$h6d$1@ger.gmane.org> <mailman.284.1462120216.32212.python-list@python.org> <572630a1$0$1595$c3e8da3$5496439d@news.astraweb.com> <ng5cu6$ejq$1@ger.gmane.org> <mailman.286.1462122256.32212.python-list@python.org> <5726b1f3$0$1603$c3e8da3$5496439d@news.astraweb.com> <ng6sd8$kt$1@ger.gmane.org>
Mime-Version 1.0
Content-Type text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding 7bit
X-Trace news.uni-berlin.de Cuewpz1aR0t6i0M6lEy0ywvfexuGPcS3cz7MrRcRpRXQ==
Return-Path <python-python-list@m.gmane.org>
X-Original-To python-list@python.org
Delivered-To python-list@mail.python.org
X-Spam-Status OK 0.000
X-Spam-Evidence '*H*': 1.00; '*S*': 0.00; 'subject:Python': 0.05; "'python": 0.07; 'unittest': 0.07; 'subject:help': 0.07; 'assumed': 0.09; 'received:80.91': 0.09; 'received:80.91.229': 0.09; 'received:gmane.org': 0.09; 'received:list': 0.09; 'python': 0.10; 'jan': 0.11; 'discussions': 0.15; 'properly': 0.15; '2016': 0.16; 'argument.': 0.16; 'linux/unix?': 0.16; 'received:80.91.229.3': 0.16; 'received:io': 0.16; 'received:plane.gmane.org': 0.16; 'received:psf.io': 0.16; 'reedy': 0.16; 'subject:show': 0.16; 'subject:when': 0.16; 'wrote:': 0.16; 'obviously': 0.16; '>>>': 0.20; 'windows': 0.20; 'file.': 0.22; 'pass': 0.22; 'am,': 0.23; 'unix': 0.24; 'header :In-Reply-To:1': 0.24; 'mon,': 0.24; 'header:User-Agent:1': 0.26; 'command': 0.26; 'header:X-Complaints-To:1': 0.26; 'linux': 0.26; 'specify': 0.27; 'function': 0.28; 'this.': 0.28; 'command-line': 0.29; "i'm": 0.30; "we're": 0.30; 'users.': 0.31; '[1]': 0.32; "d'aprano": 0.33; 'hopefully': 0.33; 'steven': 0.33; 'utility': 0.33; 'file': 0.34; 'except': 0.34; 'list': 0.34; 'but': 0.36; 'there': 0.36; 'to:addr:python-list': 0.36; 'subject:?': 0.36; 'pm,': 0.36; 'subject:: ': 0.37; 'expect': 0.37; 'received:org': 0.37; 'beyond': 0.37; 'signature': 0.37; 'release': 0.37; 'manual': 0.38; 'test': 0.39; "didn't": 0.39; 'enough': 0.39; 'to:addr:python.org': 0.40; 'some': 0.40; 'hope': 0.61; 'real': 0.62; 'received:96': 0.63; 'soon': 0.65; '>>>>>': 0.66; 'better.': 0.66; 'talking': 0.67; 'edwards': 0.91; 'received:fios.verizon.net': 0.91
X-Injected-Via-Gmane http://gmane.org/
X-Gmane-NNTP-Posting-Host pool-96-227-207-81.phlapa.fios.verizon.net
User-Agent Mozilla/5.0 (Windows NT 10.0; WOW64; rv:45.0) Gecko/20100101 Thunderbird/45.0
In-Reply-To <5726b1f3$0$1603$c3e8da3$5496439d@news.astraweb.com>
X-BeenThere python-list@python.org
X-Mailman-Version 2.1.22
Precedence list
List-Id General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe <https://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive <http://mail.python.org/pipermail/python-list/>
List-Post <mailto:python-list@python.org>
List-Help <mailto:python-list-request@python.org?subject=help>
List-Subscribe <https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
X-Mailman-Original-Message-ID <ng6sd8$kt$1@ger.gmane.org>
X-Mailman-Original-References <1462074388.273747.594588777.5E705539@webmail.messagingengine.com> <20160501052434.GA98660@cskk.homeip.net> <CAPTjJmr5E8zGB6Q0WWaja1DkZqac0SVm2X5eXOvYvd4YE3vZCg@mail.gmail.com> <ng51p3$c81$1@ger.gmane.org> <mailman.283.1462110832.32212.python-list@python.org> <87r3dlolx6.fsf@elektro.pacujo.net> <ng5aub$h6d$1@ger.gmane.org> <mailman.284.1462120216.32212.python-list@python.org> <572630a1$0$1595$c3e8da3$5496439d@news.astraweb.com> <ng5cu6$ejq$1@ger.gmane.org> <mailman.286.1462122256.32212.python-list@python.org> <5726b1f3$0$1603$c3e8da3$5496439d@news.astraweb.com>
Xref csiph.com comp.lang.python:107994

Show key headers only | View raw


On 5/1/2016 9:48 PM, Steven D'Aprano wrote:
> On Mon, 2 May 2016 03:04 am, Grant Edwards wrote:
>
>> On 2016-05-01, Steven D'Aprano <steve@pearwood.info> wrote:
>>> On Mon, 2 May 2016 02:30 am, Grant Edwards wrote:
>>>
>>>>> In discussions like these, it would be important to draw from
>>>>> precedents. Are there commands that have such an option?
>>>>
>>>> It's pretty rare.  It is assumed that Unix uses can type " | less"
>>>
>>> Is nobody except me questioning the assumption that we're only
>>> talking about Unix users?
>>
>> Didn't the OP specify that he was writing a command-line utility for
>> Linux/Unix?
>
> *cough* I'm the OP, and no I didn't.
>
> Obviously I'm a Linux user myself, but I'm presumptuous enough to hope that
> when I release the utility publicly[1], others may find it of some small
> use. Including Windows users.
>
> [1] Real Soon Now.

As a Windows user in recent years, I expect -h to give me a list of 
options, hopefully with some annotation beyond the bare bones, that give 
the signature of the command (regarding it as a function call).  'python 
-h' is pretty bare bones.  'python -m test -h' is much better.  I expect 
both to tell me how to properly pass a file argument.  I don't expect 
either to tell me how write a python or unittest file.  I use the manual 
for this.

-- 
Terry Jan Reedy

Back to comp.lang.python | Previous | NextPrevious in thread | Next in thread | Find similar | Unroll thread


Thread

Re: What should Python apps do when asked to show help? Grant Edwards <grant.b.edwards@gmail.com> - 2016-05-01 13:53 +0000
  Re: What should Python apps do when asked to show help? Marko Rauhamaa <marko@pacujo.net> - 2016-05-01 18:08 +0300
    Re: What should Python apps do when asked to show help? Grant Edwards <grant.b.edwards@gmail.com> - 2016-05-01 16:30 +0000
      Re: What should Python apps do when asked to show help? Steven D'Aprano <steve@pearwood.info> - 2016-05-02 02:36 +1000
        Re: What should Python apps do when asked to show help? Grant Edwards <grant.b.edwards@gmail.com> - 2016-05-01 17:04 +0000
          Re: What should Python apps do when asked to show help? Steven D'Aprano <steve@pearwood.info> - 2016-05-02 11:48 +1000
            Re: What should Python apps do when asked to show help? Terry Reedy <tjreedy@udel.edu> - 2016-05-02 02:34 -0400
        Re: What should Python apps do when asked to show help? Gene Heskett <gheskett@wdtv.com> - 2016-05-01 13:09 -0400
        Re: What should Python apps do when asked to show help? Random832 <random832@fastmail.com> - 2016-05-01 13:49 -0400
        Re: What should Python apps do when asked to show help? Ethan Furman <ethan@stoneleaf.us> - 2016-05-01 10:54 -0700

csiph-web