Update purpose in module descriptions

[pyi2ncommon] / doc / index.rst

diff --git a/doc/index.rst b/doc/index.rst
index ffd006d..820acd2 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -6,7 +6,22 @@
 Welcome to pyi2ncommon's documentation!
 =======================================
 
-This library is intended to hold python helper code used everywhere in Intra2net code. It is starting small but will surely grow...
+This library has two main purposes:
+  (1) provide an interface to external python code (i.e., code not running
+      inside a Intra2net system, most notably QA tests) to some of the internal
+      workings of Intra2net systems. This includes:
+         - the configuration system (module :py:mod:`pyi2ncommon.cnfvar`)
+         - interactions with the central daemon (:py:mod:`pyi2ncommon.arnied_api`,
+           :py:mod:`pyi2ncommon.arnied_wrapper`)
+         - interactions with the connection daemon (:py:mod:`pyi2ncommon.dial`, :py:mod:`pyi2ncommon.connd_state`)
+  (2) provide helpers for internal source code, to simplify creating tests or helper scripts in python
+      that run inside an Intra2net-system. Featuring: :py:mod:`pyi2ncommon.argparse_helpers`,
+      :py:mod:`pyi2ncommon.buffers`, :py:mod:`pyi2ncommon.iter_helpers`, :py:mod:`pyi2ncommon.log_helpers`,
+      :py:mod:`pyi2ncommon.log_read`, :py:mod:`pyi2ncommon.text_helpers`
+
+The selection of modules listed here is not complete; modules are not "tied" to one of these two
+purposes, most modules can be used inside or outside an Intra2net system.
+
 
 Contents: