From d5b6f9fa70b7a1b6436954f0fc1087747e6b3c17 Mon Sep 17 00:00:00 2001 From: dpedu Date: Tue, 11 Aug 2015 15:24:02 -0700 Subject: [PATCH] Update docs --- docs/conf.py | 2 +- docs/module_guide/_module_guide.rst | 3 +++ pyircbot/pyircbot.py | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index adbbf34..7a135e6 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -61,7 +61,7 @@ copyright = '2015, dpedu' version = '3.4' # The full version, including alpha/beta/rc tags. import pyircbot -release = "4.0.0-r02"#pyircbot.PyIRCBot.version +release = pyircbot.PyIRCBot.version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/module_guide/_module_guide.rst b/docs/module_guide/_module_guide.rst index 0c25ad3..2773c19 100644 --- a/docs/module_guide/_module_guide.rst +++ b/docs/module_guide/_module_guide.rst @@ -149,6 +149,9 @@ Refer to existing modules for helper methods from elsewhere in PyIRCBot. - :py:meth:`pyircbot.pyircbot.PyIRCBot.getDataPath` - :py:meth:`pyircbot.pyircbot.PyIRCBot.getmodulebyname` +:doc:`GameBase ` is a good example of the basic code +structure a IRC game could follow, designed so different channels would have +separate game instances. Inter-module Communication -------------------------- diff --git a/pyircbot/pyircbot.py b/pyircbot/pyircbot.py index 30e5d83..5232f93 100644 --- a/pyircbot/pyircbot.py +++ b/pyircbot/pyircbot.py @@ -17,6 +17,7 @@ class PyIRCBot: """:param botconfig: The configuration of this instance of the bot. Passed by main.py. :type botconfig: dict """ + version = "4.0.0-r02" def __init__(self, botconfig): self.log = logging.getLogger('PyIRCBot')