Skip to content
Snippets Groups Projects
Commit 790fc49b authored by Florian Spreckelsen's avatar Florian Spreckelsen
Browse files

DOC: Document the Info class

parent 489bb54e
Branches
Tags
1 merge request!144F doc info class
...@@ -5038,6 +5038,26 @@ class UserInfo(): ...@@ -5038,6 +5038,26 @@ class UserInfo():
class Info(): class Info():
"""Info about the LinkAhead instance that you are connected to. It has a
simple string representation in the form of "Connected to a LinkAhead with N
Records".
Attributes
----------
messages : Messages
Collection of messages that the server's ``Info`` response contained.
user_info : UserInfo
Information about the user that is connected to the server, such as
name, realm or roles.
time_zone : TimeZone
The timezone information returned by the server.
Methods
-------
sync
Retrieve server information from the server's ``Info`` response.
"""
def __init__(self): def __init__(self):
self.messages = Messages() self.messages = Messages()
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment