diff --git a/src/linkahead/common/models.py b/src/linkahead/common/models.py index 5bc471d7171da4a6cd89b8da226b9e1d5f935d11..908a748cef91af7ace35d5054e558bc29bb7b1f0 100644 --- a/src/linkahead/common/models.py +++ b/src/linkahead/common/models.py @@ -5038,6 +5038,26 @@ class UserInfo(): 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): self.messages = Messages()