From 5ce523be1f131abe4f46e10ab81aa06f5942a2a9 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Mon, 2 May 2022 05:21:42 +0200 Subject: [PATCH] Improve documentation of `royalnet` --- royalnet/__init__.py | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/royalnet/__init__.py b/royalnet/__init__.py index 644b6baf..32ff895b 100644 --- a/royalnet/__init__.py +++ b/royalnet/__init__.py @@ -1,15 +1,3 @@ """ -Royalnet is a collection of many Python modules useful to build chat-like applications. - -The modules currently are: - -- :mod:`.alchemist`, containing utility extensions to :mod:`sqlalchemy`; -- :mod:`.engineer`, containing a framework for building chat bots; -- :mod:`.lazy`, containing utilities to delay the evaluation of values until they are actually used; -- :mod:`.scrolls`, containing configuration utilities; -- :mod:`.sculptor`, containing common :mod:`pydantic` models for serialization and deserialization of data structures; - -To prevent the library from breaking if optional dependencies are not installed, this module does not export any object; submodules should be directly imported instead. - -All modules use exceptions based on :exc:`.exc.RoyalnetException`, and may subclass it to provide more detail on the errors. +Royalnet is a multiplatform chatbot library which allows to write bots only once for most chat platforms and at the same time maintain the versatility of using a platform-specific framework. """