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

Automatic command description generation #13

Open
johannesE opened this issue Jun 26, 2018 · 5 comments
Open

Automatic command description generation #13

johannesE opened this issue Jun 26, 2018 · 5 comments

Comments

@johannesE
Copy link
Contributor

johannesE commented Jun 26, 2018

The botfather expects a list of commands like this:

command1 - Description
command2 - Another description

This could be generated automatically from the code. So this is a feature request. :-)

Thanks for this awesome library btw. I got started in less than a minute.

@johannesE johannesE changed the title Automatic command helpersgeneration Automatic command description generation Jun 26, 2018
@lubien
Copy link
Owner

lubien commented Jun 26, 2018

Title's interesting. Can you explain more about it?

@lubien
Copy link
Owner

lubien commented Jun 26, 2018

No problem, I always press enter here and send stuff before finishing.

Indeed, that's a cool feature and I think it'd be great to have here.

I'm a little short in time for this week. Wanna give a try? Or I can schedule to give a looks on this later.

Thanks for pointing out this feature, btw!

@johannesE
Copy link
Contributor Author

I am unsure yet on how to automatically generate this, but yes, I'll take a look :). The result would ideally be a mix command that returns the documentation ready for copy pasting based on the use of the command makro. For the description it takes either an option parameter or the line just above it.

@lubien
Copy link
Owner

lubien commented Jun 26, 2018

Maybe you could use Elixir's approach of '@doc' although I don't know if it's possible for macros, so I'm just aiming at the dark.

If you find some interesting approach comment here so we can look for a good standard on how to write the description.

@johannesE
Copy link
Contributor Author

FYI: I asked for help here: https://elixirforum.com/t/parsing-and-creating-documentation-at-compile-time/14864

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants