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

Clarify README about what this package does #267

Closed
timholy opened this issue Jan 7, 2024 · 2 comments
Closed

Clarify README about what this package does #267

timholy opened this issue Jan 7, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@timholy
Copy link

timholy commented Jan 7, 2024

While browsing through Revise issues I found this package. Not being a user of Python/docopt or Fire, I struggle to understand from the README what niche this package fills. I don't think I understood it until I visited the GitHub page for docopt and saw the title "docopt creates beautiful command-line interfaces"---perhaps that's the purpose of Comonicon? Aside from saying that directly, perhaps the demo in https://github.com/comonicon/Comonicon.jl#zero-duplication could explicitly show how one calls main from the command line?

I would recommend putting statements like The frontend @main and @cast will try to parse everything you typed and turn them into part of your command line. This includes your function or module docstrings, your argument and keyword argument names, types and default values second, after you've told ignorant potential users why they might be interested in using Comonicon.

@timholy timholy added the bug Something isn't working label Jan 7, 2024
@Roger-luo
Copy link
Collaborator

Roger-luo commented Jan 18, 2024

Thanks, Tim! I have been a bit lazy in updating the documentation of this package. Let me update the README now. Please also feel free to change the README through PR

@timholy
Copy link
Author

timholy commented Jan 18, 2024

Oh, so much nicer now, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants