GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2025-02-20 07:20:59 +01:00
Code Issues Projects Releases Wiki Activity

utils: clarify ServiceBot.(join|part) docstrings

Browse Source
This commit is contained in:
James Lu 2018-07-02 00:35:40 -07:00
parent 0ccaac595b
commit 0c55569c1f
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
utils.py
View File

@ -153,11 +153,15 @@ class ServiceBot():
def join(self, irc, channels, ignore_empty=True): def join(self, irc, channels, ignore_empty=True):
""" """
Joins the given service bot to the given channel(s). "channels" can be Joins the given service bot to the given channel(s). "channels" can be
an iterable of channel names or the name of a single channel (str). an iterable of channel names or the name of a single channel (type 'str').
The ignore_empty option sets whether we should skip joining empty The ignore_empty option sets whether we should skip joining empty
channels and join them later when we see someone else join. This is channels and join them later when we see someone else join (for channels
option is disabled on networks where we cannot monitor channel state. marked persistent). This option is automatically *disabled* on networks
where we cannot monitor channels that we're not in (e.g. Clientbot).
Before PyLink 2.0-alpha3, this function implicitly marks channels i
receives to be persistent - this is no longer the case!
""" """
uid = self.uids.get(irc.name) uid = self.uids.get(irc.name)
if uid is None: if uid is None:
@ -201,7 +205,7 @@ class ServiceBot():
still register it as a persistent dynamic channel. still register it as a persistent dynamic channel.
"channels" can be an iterable of channel names or the name of a single "channels" can be an iterable of channel names or the name of a single
channel (str). channel (type 'str').
""" """
uid = self.uids.get(irc.name) uid = self.uids.get(irc.name)
if uid is None: if uid is None: