Re: Understanding "help" command description syntax - explanation needed

Path	csiph.com!v102.xanadu-bbs.net!xanadu-bbs.net!feeder.erje.net!eu.feeder.erje.net!news.stack.nl!newsfeed.xs4all.nl!newsfeed2a.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail
Return-Path	<rosuav@gmail.com>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.002
X-Spam-Evidence	'H': 1.00; 'S': 0.00; 'syntax': 0.04; 'conventions': 0.07; 'subject:help': 0.08; 'arguments': 0.09; 'subject:command': 0.09; 'cc:addr:python-list': 0.11; 'clues': 0.16; 'command-line': 0.16; 'from:addr:rosuav': 0.16; 'from:name:chris angelico': 0.16; 'ivan': 0.16; 'mean,': 0.16; 'notations': 0.16; 'subject:description': 0.16; 'wrote:': 0.18; 'wed,': 0.18; 'cc:addr:python.org': 0.22; 'cc:2**0': 0.24; 'this:': 0.26; 'header:In-Reply-To:1': 0.27; 'message- id:@mail.gmail.com': 0.30; "i'm": 0.30; 'something': 0.35; 'but': 0.35; 'received:google.com': 0.35; 'there': 0.35; 'url:org': 0.36; 'nov': 0.38; 'same.': 0.38; 'subject:needed': 0.38; 'pm,': 0.38; 'explain': 0.39; 'subject:" ': 0.39; 'talking': 0.65; 'concept.': 0.84; 'to:none': 0.92
DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:cc :content-type; bh=8s7Ccn7Py/OGYxE8nS/eFJL2XvPLE6HN0dgghqEE1/I=; b=L9Yqa2pK2MTSZNlnyb4KMIv2xw7jNdtztoiXN0sdu89htqH/XCu7ziTWtxWHu9shtK /1gpewadkR+LlIWINBkFHEPQ5dA8cVgOZLGRSCHAylGxf4vcRKRBDL+JSJvFpIPJX3Es U6jDvwZYPxNwail/5S9xE6pXfjzV9l3nt6f+s3mEeotyHA1Oxcxu5+iLDb0XXYeL2Ou6 MbgoTLank7OBDZwE1pttWLvrbOxD624rZJmm5xs+nmWylksPe+Y+Qp7qesrJkGq6M92I d1SqD79/6dFOR5PFecyY2IQLCFnumKy1z35G9qh4812UAdmje7uMAugqBEmakB/7RIq6 Bzcg==
MIME-Version	1.0
X-Received	by 10.107.18.151 with SMTP id 23mr40227409ios.27.1415190389119; Wed, 05 Nov 2014 04:26:29 -0800 (PST)
In-Reply-To	<000501cff8f1$ed99cc40$c8cd64c0$@gmail.com>
References	<000001cff8e7$af51ef30$0df5cd90$@gmail.com> <88543346.5460.1415188500802.JavaMail.root@sequans.com> <000501cff8f1$ed99cc40$c8cd64c0$@gmail.com>
Date	Wed, 5 Nov 2014 23:26:29 +1100
Subject	Re: Understanding "help" command description syntax - explanation needed
From	Chris Angelico <rosuav@gmail.com>
Cc	"python-list@python.org" <python-list@python.org>
Content-Type	text/plain; charset=UTF-8
X-BeenThere	python-list@python.org
X-Mailman-Version	2.1.15
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>
Newsgroups	comp.lang.python
Message-ID	<mailman.15494.1415190398.18130.python-list@python.org> (permalink)
Lines	14
NNTP-Posting-Host	2001:888:2000:d::a6
X-Trace	1415190398 news.xs4all.nl 2946 [2001:888:2000:d::a6]:51546
X-Complaints-To	abuse@xs4all.nl
Xref	csiph.com comp.lang.python:80265

Show key headers only | View raw

On Wed, Nov 5, 2014 at 11:13 PM, Ivan Evstegneev
<webmailgroups@gmail.com> wrote:
> That's what I'm talking about (asking actually), where do you know it from?
> I mean, if there are some resources, which explain all these syntax abbreviations? The general concept.

The best way to find clues about what the conventions mean is to find
something that codifies them in some way. Like this:

http://docopt.org/

That's talking about command-line arguments to an application, but a
lot of the notations are the same.

ChrisA

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

Thread

Re: Understanding "help" command description syntax - explanation needed Chris Angelico <rosuav@gmail.com> - 2014-11-05 23:26 +1100

csiph-web