mirror of
https://github.com/progval/Limnoria.git
synced 2025-04-26 13:01:06 -05:00
Correctly document meaning of None vs absent values in nicksToAccounts
This commit is contained in:
parent
53b45c1d47
commit
448d9771f8
@ -684,9 +684,10 @@ class IrcState(IrcCommandDispatcher, log.Firewalled):
|
|||||||
|
|
||||||
.. attribute:: nicksToAccounts
|
.. attribute:: nicksToAccounts
|
||||||
|
|
||||||
Stores the current services account name of a seen nick.
|
Stores the current services account name of a seen nick (or
|
||||||
|
:const:`None` for un-identified nicks)
|
||||||
|
|
||||||
:type: ircutils.IrcDict[str, str]
|
:type: ircutils.IrcDict[str, Optional[str]]
|
||||||
"""
|
"""
|
||||||
__firewalled__ = {'addMsg': None}
|
__firewalled__ = {'addMsg': None}
|
||||||
|
|
||||||
@ -807,7 +808,8 @@ class IrcState(IrcCommandDispatcher, log.Firewalled):
|
|||||||
|
|
||||||
def nickToAccount(self, nick):
|
def nickToAccount(self, nick):
|
||||||
"""Returns the account for a given nick, or None if the nick is logged
|
"""Returns the account for a given nick, or None if the nick is logged
|
||||||
out."""
|
out. Raises :exc:`KeyError` if the nick was not seen or its account is
|
||||||
|
not known yet."""
|
||||||
return self.nicksToAccounts[nick]
|
return self.nicksToAccounts[nick]
|
||||||
|
|
||||||
def getParentBatches(self, msg):
|
def getParentBatches(self, msg):
|
||||||
|
Loading…
x
Reference in New Issue
Block a user