jessevdk / go-flags

go command line option parser
http://godoc.org/github.com/jessevdk/go-flags
BSD 3-Clause "New" or "Revised" License
2.59k stars 308 forks source link

Document return value of Parse/ParseArgs #343

Closed golightlyb closed 3 years ago

golightlyb commented 4 years ago

The return value of the plain Parse/ParseArgs functions aren't explained unless you dig down as far as (*Parser) ParseArgs.

This commit copies that information up to Parse/ParseArgs too.

golightlyb commented 3 years ago

This might be out of date, I can't remember what this was about.