search

jessevdk / go-flags

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

Documentation: Add more Examples #368

Open stellarpower opened 3 years ago

stellarpower commented 3 years ago

This seems to be a really nice, comprehensive library, with lots of great features. As a non-Go programmer, it would have helped me to have had more examples to show off a lot of the varied support the library has. We all leave documentation to the last bit, but in a way, there's nothing worse than when someone's done a lot of work and a good job but not being able to see the final product clearly as a user programmer!

I also see that there are some in the Examples folder, but I didn't find this via the Go package documentation. It's an obvious place to put it, but that page is the first place I have been looking, and generally would be, so it would help to include a link on that page to the examples folder in the repo.

darylwright commented 2 years ago

I agree. While this is a great library, there is nothing worse, even for an experienced programmer, than to find one that has insufficient documentation. It wastes far too much developer time to scour through the API simply to infer how to use the library. For a product that intends to be production grade, the documentation is as important as the code itself.