From src/twisted/words/protocols/jabber/client.py: (irrelevant parts cut out)
class BasicAuthenticator(xmlstream.ConnectAuthenticator):
"""
Authenticates an XmlStream against a Jabber server as a Client.
@cvar INVALID_USER_EVENT: See L{IQAuthInitializer.INVALID_USER_EVENT}.
@type INVALID_USER_EVENT: L{str}
@cvar AUTH_FAILED_EVENT: See L{IQAuthInitializer.AUTH_FAILED_EVENT}.
@type AUTH_FAILED_EVENT: L{str}
@cvar REGISTER_FAILED_EVENT: Token to signal that registration failed.
@type REGISTER_FAILED_EVENT: L{str}
"""
INVALID_USER_EVENT = IQAuthInitializer.INVALID_USER_EVENT
AUTH_FAILED_EVENT = IQAuthInitializer.AUTH_FAILED_EVENT
REGISTER_FAILED_EVENT = "//event/client/basicauth/registerfailed"Currently pydoctor will handle INVALID_USER_EVENT and AUTH_FAILED_EVENT as aliases, which means that it keeps track of the indirections, but doesn't include them in the output. However, as they are documented names, they should be given documentation entries.
From src/twisted/python/constants.py:
# Import and re-export Constantly
from constantly import NamedConstant, ValueConstant, FlagConstant, Names, Values, Flags
__all__ = ["NamedConstant", "ValueConstant", "FlagConstant", "Names", "Values", "Flags"]
Since these names are explicitly exported via __all__, they should end up in the output. But currently the documentation for twisted.python.constants is empty.
So I think aliases should sometimes be Documentables.
From
src/twisted/words/protocols/jabber/client.py: (irrelevant parts cut out)Currently pydoctor will handle
INVALID_USER_EVENTandAUTH_FAILED_EVENTas aliases, which means that it keeps track of the indirections, but doesn't include them in the output. However, as they are documented names, they should be given documentation entries.From
src/twisted/python/constants.py:Since these names are explicitly exported via
__all__, they should end up in the output. But currently the documentation fortwisted.python.constantsis empty.So I think aliases should sometimes be
Documentables.