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

Command docs vastly out of date #96

Open
Profpatsch opened this issue Jan 21, 2014 · 1 comment
Open

Command docs vastly out of date #96

Profpatsch opened this issue Jan 21, 2014 · 1 comment

Comments

@Profpatsch
Copy link

https://github.com/flatland/lazybot/wiki/Commands

Atm one has to look at the code to see what the plugins do. Most of them don’t even have any docstrings.

@Raynes
Copy link
Owner

Raynes commented Jan 21, 2014

At the time that document was created it was extremely difficult to keep up with the speed at which lazybot was being developed. New plugins were coming extremely fast, and changes were being made constantly to existing ones.

The original plan was to generate documentation and that's still what I'd like to do. The infrastructure is in place to do it. All commands can have associated docstrings. Even if they don't, they can and should. I don't know of plugins themselves can have docstrings, but that should be a possibility as well.

I'd love to do this, but I may not have the time for a while. This is a very important task for anyone who would like to take it on. I'll happily provide some support to anyone who wants to give it a shot. Otherwise, I'll get to it eventually.

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