Merge pull request #39 from max-au/max-au/fix-parse-spec

[argparse] fix incorrect specs

README.md

@@ -198,6 +198,9 @@ To be considered after 1.2.0:
 
 ## Changelog
 
+Verson 1.2.4:
+ * minor spec fixes
+
 Verson 1.2.3:
  * implemented global default
  * minor bugfixes

doc/overview.edoc

@@ -1,6 +1,6 @@
  ** this is the overview.doc file for the application 'argparse' **
 
-   @version 1.2.3
+   @version 1.2.4
    @author Maxim Fedorov, <maximfca@gmail.com>
    @title argparse: A simple framework to create complex CLI.
 

rebar.lock

@@ -0,0 +1 @@
+[].

src/argparse.app.src

@@ -1,6 +1,6 @@
 {application, argparse,
  [{description, "argparse: arguments parser, and cli framework"},
-  {vsn, "1.2.3"},
+  {vsn, "1.2.4"},
   {applications,
    [kernel,
     stdlib

src/argparse.erl

@@ -239,18 +239,18 @@
     command => [string()]   %% nested command (missing/empty for top-level command)
 }.
 
--type command_spec() :: {Name :: string(), command()}. %% Command name with command spec
+-type command_spec() :: {Name :: [string()], command()}. %% Command name with command spec
 
 -type parse_result() :: arg_map() | {arg_map(), command_spec()}. %% Result returned from parse/2,3: can be only argument map,  or argument map with command_spec.
 
 %% @equiv validate(Command, #{})
--spec validate(command()) -> command_spec().
+-spec validate(command()) -> {Progname :: string(), command()}.
 validate(Command) ->
     validate(Command, #{}).
 
 %% @doc Validate command specification, taking Options into account.
 %% Generates error signal when command specification is invalid.
--spec validate(command(), parser_options()) -> command_spec().
+-spec validate(command(), parser_options()) -> {Progname :: string(), command()}.
 validate(Command, Options) ->
     validate_impl(Command, Options).