Georg/dbot
1
0
Fork 0
forked from GitHub/dbot
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation for polls [#75]

Browse Source
This commit is contained in:
reality 2012-12-30 18:38:36 +00:00
parent 6f5105e36c
commit 887e854012
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
modules/poll/README.md Normal file
View File

@ -0,0 +1,35 @@
## Poll
Pollers gonna poll.
### Description
This module allows creation of and voting in polls, with associated
functionality.
Note that while in terms of the interface all votes are anonymous, users'
voting choices are stored in the database for the purpose of users being
able to change their votes. Therefore an admin can technically go delving in
the database to see users' voting choices.
### Commands
#### ~newpoll [pollname] options=[each,poll,option] [Poll Description]
Creates a new poll with the given name, options and descriptions. From this
point people will be able to use the ~vote command to cast their vote in the
poll.
#### ~addoption [pollname] [newoption]
Using this command you can add a given option to a poll you are the creator of.
#### ~rmoption [pollname] [optiontoremove]
Using this command you can remove a given option from a poll you are the creator
of.
#### ~vote [pollname] [option]
Cast your vote for the given option in the given poll. If you have already cast
your vote in the given poll, your vote will be changed to the new option you
have provided.
#### ~pdesc [pollname]
Show the full description for a given poll name along with its available voting
options.