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.

Sign up for GitHub

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

Updated API information #240

Merged
merged 1 commit into from
Jun 5, 2014
Merged

Updated API information #240

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/API.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ Client
`messageSplit` will split up large messages sent with the `say` method
into multiple messages of length fewer than `messageSplit` characters.

Setting `debug` to true will emit timestamped messages to the console
using `util.log` when certain events are fired.

`autoRejoin` has the client rejoin channels after being kicked.

Setting `autoConnect` to false prevents the Client from connecting on
instantiation. You will need to call `connect()` on the client instance::

Expand Down