From e3c4cdb456055b3a66c3c3db1e2f1a70d0116ebe Mon Sep 17 00:00:00 2001 From: Pavel Tisnovsky Date: Tue, 26 Aug 2025 11:24:37 +0200 Subject: [PATCH] Updated documentation for the main module --- src/README.md | 6 +++--- src/__init__.py | 2 +- src/client.py | 2 +- src/lightspeed_stack.py | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/README.md b/src/README.md index 5dda5282..06b00b64 100644 --- a/src/README.md +++ b/src/README.md @@ -1,10 +1,10 @@ # List of source files stored in `src/` directory ## [__init__.py](__init__.py) -Main classes for the Lightspeed-stack. +Main classes for the Lightspeed Core Stack REST API service. ## [client.py](client.py) -LLama stack client retrieval. +LLama Stack client retrieval class. ## [configuration.py](configuration.py) Configuration loader. @@ -13,7 +13,7 @@ Configuration loader. Constants used in business logic. ## [lightspeed_stack.py](lightspeed_stack.py) -Lightspeed stack. +Entry point to the Lightspeed Core Stack REST API service. ## [log.py](log.py) Log utilities. diff --git a/src/__init__.py b/src/__init__.py index b3e84724..dce27c1b 100644 --- a/src/__init__.py +++ b/src/__init__.py @@ -1 +1 @@ -"""Main classes for the Lightspeed-stack.""" +"""Main classes for the Lightspeed Core Stack REST API service.""" diff --git a/src/client.py b/src/client.py index 2dcbfdc1..c44c774c 100644 --- a/src/client.py +++ b/src/client.py @@ -1,4 +1,4 @@ -"""LLama stack client retrieval.""" +"""LLama Stack client retrieval class.""" import logging diff --git a/src/lightspeed_stack.py b/src/lightspeed_stack.py index 83f0e0e9..5edd6989 100644 --- a/src/lightspeed_stack.py +++ b/src/lightspeed_stack.py @@ -1,4 +1,4 @@ -"""Lightspeed stack. +"""Entry point to the Lightspeed Core Stack REST API service. This source file contains entry point to the service. It is implemented in the main() function.