Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for Help Text #88

Closed
dregad opened this issue Aug 28, 2017 · 3 comments
Closed

Improve documentation for Help Text #88

dregad opened this issue Aug 28, 2017 · 3 comments

Comments

@dregad
Copy link
Contributor

dregad commented Aug 28, 2017

I find the page at http://getopt-php.github.io/getopt-php/help.html a bit confusing, it's not really clear just reading that and without looking at the code, to understand what has to be done, and how one is supposed to customize things.

@tflori
Copy link
Member

tflori commented Aug 28, 2017

Without looking at the code it will be hard to understand how to customize the help text. I will have to think more about it..

Sent from my OnePlus ONEPLUS A3003 using FastHub

@tflori
Copy link
Member

tflori commented Aug 29, 2017

@dregad I had a look into the current help and had the same impression 😄

https://github.com/getopt-php/getopt-php/blob/4283ba7302bd069c9eb48c6b7a8fe859d980d488/docs/help.md

It was describing the the three templates before the customization. I changed this and the texts. How else we could improve this documentation?

@dregad
Copy link
Contributor Author

dregad commented Aug 29, 2017

Thanks for the quick response, I made some suggestions for improvement in #90, and see also #91.

@tflori tflori closed this as completed Aug 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants