rougeth / bottery

[DEVELOPMENT-HALTED] :battery: A bot framework with batteries included
MIT License
344 stars 51 forks source link

Include docs for msghandlers list #133

Closed rennerocha closed 6 years ago

rennerocha commented 6 years ago

I found that the content of https://docs.bottery.io/en/latest/patterns.html is not updated with the structure that are created after using the startproject command. There is no more a bot.py file, and the messages are handled by a msghandlers list (is this slightly inspired by Django URL confs?)

I needed to dig into the code to understand how this works (and I hope that I understood it correctly :smile: ), so I tried to improve the documentation with the thing that I found.

I don't know if the old method with decorators will still continue being used, so I didn't remove the patterns.rst file . However, it may be removed as well if msghandlers will be the only way to define the rules from now.

Please let me know if something is incorrect (or that will be changed in the nearest future), so I can try to fix it.

rennerocha commented 6 years ago

Is the patterns.rst page still valid? Or it should be dropped from the docs?

rougeth commented 6 years ago

@rennerocha thank you very much! Updating the docs is one of the hardest parts of the project.

You probably jumped the lines according to your text editor, right? e.g:

5 +This file contains the rules that allow the bot to decide which view will
6 +respond the messages.

This example should be in only one line. Having text wrap set up on your editor should help write docs.

And no, patterns.rst isn't relevant anymore.

rougeth commented 6 years ago

@rennerocha almost done! Need to update branch and remove reference of patterns.rst on docs/index.rst:19, which is broken on CI.

rougeth commented 6 years ago

@rennerocha thank you very much!