From f7ea75dd09801c46123d3c11740dea00ce4f3182 Mon Sep 17 00:00:00 2001
From: Florian Hatat <weboob@hatat.me>
Date: Sun, 18 Nov 2018 18:28:28 +0100
Subject: [PATCH] WebNip: short explanatory paragraph on the class role

---
 weboob/core/ouiboube.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/weboob/core/ouiboube.py b/weboob/core/ouiboube.py
index cc1027a656..da796a7971 100644
--- a/weboob/core/ouiboube.py
+++ b/weboob/core/ouiboube.py
@@ -47,6 +47,12 @@ class WebNip(object):
     It provides methods to build backends or call methods on all loaded
     backends.
 
+    You should use this class when you want to build an application
+    using Weboob as a library, without using the standard modules nor
+    the automatic module download and update machanism. When using
+    WebNip, you have to explicitely provide module paths and deal
+    yourself with backend configuration.
+
     :param modules_path: path to directory containing modules.
     :type modules_path: :class:`basestring`
     :param storage: provide a storage where backends can save data
-- 
GitLab