From 790fc49b4b5c7838aade1490d40adc04c166e502 Mon Sep 17 00:00:00 2001
From: Florian Spreckelsen <f.spreckelsen@indiscale.com>
Date: Tue, 16 Jul 2024 10:53:50 +0200
Subject: [PATCH] DOC: Document the Info class
---
src/linkahead/common/models.py | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/src/linkahead/common/models.py b/src/linkahead/common/models.py
index 5bc471d7..908a748c 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()
--
GitLab