Opened 5 years ago
Last modified 5 years ago
#3953 reopened enhancement
Informal CLI syntax
Reported by: | jidanni | Owned by: | |
---|---|---|---|
Priority: | minor | Milestone: | 7.8.3 |
Component: | Docs | Version: | git-releasebranch78 |
Keywords: | Cc: | ||
CPU: | Unspecified | Platform: | Unspecified |
Description
From its examples, one concurs the SYNOPSIS
v.segment input=name [layer=strin...
should by written
v.segment [input=]name [layer=strin...
or enhance the v.segment examples to match the SYNOPSIS.
Also on man v.in.ascii the examples contain in= and out=. If these are informal aliases for input= and output=, then the SYNOPSIS should say so. Else they are invalid examples. Same with Usage message seen with v.in.ascii --help.
Anyway there seem to be many man pages with examples from a previous informal age, not matching the more formal syntax in their SYNOPSIS.
Change History (5)
comment:1 by , 5 years ago
Milestone: | → 7.8.2 |
---|---|
Resolution: | → fixed |
Status: | new → closed |
Version: | unspecified → git-releasebranch78 |
comment:2 by , 5 years ago
Resolution: | fixed |
---|---|
Status: | closed → reopened |
Wait, you still need to fix v.in.ascii, as mentioned above.
And in fact tons more of the man pages suffer the same problem.
comment:5 by , 5 years ago
Milestone: | → 7.8.3 |
---|
Good point. Fixed in