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

Update README, Cookbook and documentation #67

Open
PythooonUser opened this issue Jul 9, 2018 · 4 comments
Open

Update README, Cookbook and documentation #67

PythooonUser opened this issue Jul 9, 2018 · 4 comments

Comments

@PythooonUser
Copy link
Collaborator

Summary

Since we are about to introduce many name regarding changes, we need to update the documentation accordingly.

The work needed to be done here is to:

  • Change the examples in the README
  • Change the examples in the setup.py PyPi file
  • Change the examples in the GitHub Cookbook
  • Change the internal docstrings
  • Change what is left in the Sphinx documentation
@PythooonUser
Copy link
Collaborator Author

This is of course an issue to tackle after all the work is done!

@PythooonUser PythooonUser added this to the Version v0.10.0 milestone Jul 10, 2018
@senpos
Copy link
Contributor

senpos commented Jul 10, 2018

Change the examples in the README

What about echo_bot example using the new on_event decorator?

from twitchobserver import Observer, ChatEventType

observer = Observer(<BOT_USERNAME>, <BOT_OAUTH>)
observer.join_channel(<CHANNEL>)


@observer.on_event(ChatEventType.TWITCHCHATMESSAGE)
def echo_handler(event):
    observer.send_message(event.message, event.channel)

observer.start()

on_command bot would be also cool to have there, once the feature appear

I will try to handle all of this at the evening, once naming issue will be discussed

@PythooonUser
Copy link
Collaborator Author

I think we should definetly show both ways, decorators being only quality of life improvements.

@joshuaskelly
Copy link
Owner

I think the Cookbook should have actual use cases that folks can directly use. We also should have one that uses decorators. 😄

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

3 participants