Update documentation
Issue #7
new
Some enhancements to the existing documentation, in special the examples and SPS, could be helpful to users.
For users/beginners:
- Other examples, such as running a simple command
- Adding new words to dictionary (unless they are automagically created on the fly by SpeakPython)
- FAQ or common mistakes in SPS
For developers:
- Explain how each library is being used in SpeakPython. I'm a Java developer, but try to write code in Python sometimes. Knowing which are the underlying solutions help to debug errors, but also to look at similar tools in other languages (and maybe contribute back to SpeakPython, who knows)
Comments (5)
-
repo owner
-
reporter
Looking good! Had a quick look, no typos, and the content seems helpful for beginners like me. Thanks for taking care of this so fast.
-
repo owner
Development will really pick up two weeks from now, as I have an interview for a really nice job that I'm preparing for right now. This project is my baby though, so thank you so much for helping me improve it! It really means a lot to me. Let me know if you have any more suggestions. Thanks!
-
reporter
Well, since you asked :-)
https://bitbucket.org/matthew3/speakpython/issue/8/use-nlp-to-match-commands-too
And here's what I'll show my co-workers tomorrow morning: https://github.com/kinow/LinuxCommands
I'll update the repo in the next days, renaming it, polishing the code and creating a simple README, so if you have a section like Examples, Demos, Use Cases, etc, maybe we could link it there (it may be forked to the github.com/niwa repo in the next days tho).
It tries to match the city with a list of cities supported by NIWA Weather (weather.niwa.co.nz) and sends a command via telnet to Firefox - that has an extension to remote control the browser - to show the weather for the desired city :)
-
repo owner
That's really awesome! I'm so glad you're finding good use of the library in this way. I would be delighted to link your example to the library, maybe in a user-submitted section, or not. I really need to sort out the dictionary enhancement when I get back. It will be my number 1 priority. Let me know what your co-workers think :)
- Log in to comment
I cleaned up the users/beginners wiki a lot. Thank you for the suggestions. I still need to set up the FAQ and about how to add new words to the dictionary (which you know more about than I do at the moment).
I'll be adding a bunch of documentation of the actual library code as a separate wiki for anyone who wishes to look through it, alter it, understand the process, or give enhancement suggestions.
It really would help for developers to understand the flow of the library, as it makes it really easy for me to debug things.