open-wa / wa-automate-python

💬 🤖 The most advanced Python whatsapp library for chatbots with advanced features. Be sure to ⭐ this repository for updates!
Other
330 stars 71 forks source link

Suggestion: Documentation using type comment (python 2) and annotation for python 3 in the future #42

Closed darkash closed 2 years ago

darkash commented 3 years ago

As stated in https://www.python.org/doc/sunset-python-2/, python 2 is no longer maintained and is strongly asked to upgrade to python 3. I think this will be a good time on improving the docs. Lots of methods from WebWhatswrapper that this library used to based on are left undocumented and it may take a bit more time to debug and in case there's changes, we probably won't notice it until there's something wrong on production.

Better documentation also means there will be more convenience on editors that support intellisense as it will help with method prediction and such, though I'm sure many would be against this since there're still some who still used python 2 (not sure if it worked on python 2 since I used python 3). It will also help a lot for other people to contribute if they wanna add functionality to this library.

I think this is a good investment in the future :)