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

Show more succinct CLI help instead of README #39

Open
erhhung opened this issue Oct 8, 2020 · 2 comments
Open

Show more succinct CLI help instead of README #39

erhhung opened this issue Oct 8, 2020 · 2 comments

Comments

@erhhung
Copy link

erhhung commented Oct 8, 2020

It's a little "cheap" to just dump the entire README markdown file when one runs the wellknown CLI command or even by specifying the --help option. I think it's not too much to ask to display a few helpful lines for well-rounded CLI usability, no?

@ingalls
Copy link

ingalls commented Oct 8, 2020

@erhhung I would very much encourage you to rethink your choice of words in this issue. Mapbox and it's community of developers are giving you a free, open source, & well tested tool. Using the words like "cheap" when referring to open source libraries is incredibly disrespectful to the time and effort that many developers have put in without pay or compensation.

As to whether it is too much to ask, frankly - it is. You are receiving this library under an open license. No developer has an obligation to take time away from their family or hobbies to work for you. Opening an issue explaining a problem and suggesting a solution, or even better, opening a PR, will be accepted graciously.

@erhhung
Copy link
Author

erhhung commented Nov 4, 2020

@ingalls I apologize for my tone as I don't mean any disrespect given that it is open source software and I appreciate that someone had initiated an effort to provide this utility. However, since, in general, published tools, should be self-documenting and output a few succinct and readable lines of help text, by "cheap" I simply meant that I thought the app took too much of a shortcut. I can surely go the PR route, but my suggestion hadn't been worded too graciously, so I take that back.

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