From 2f3937dca3b5ba90077da6c31001de41a5517870 Mon Sep 17 00:00:00 2001
From: ulif <uli@gnufix.de>
Date: Thu, 28 Apr 2016 09:37:20 +0200
Subject: [PATCH] Tell more about the logger module.
---
diceware/logger.py | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/diceware/logger.py b/diceware/logger.py
index 54db8dd..941e94e 100644
--- a/diceware/logger.py
+++ b/diceware/logger.py
@@ -14,6 +14,16 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""logging -- output status and other data.
+
+The `logger` provided in this module is meant to be used by other
+components for messages to users.
+
+It is named `"ulif.openoffice"` and can, as a singleton, be retrieved by
+calling standard lib `logging.getLogger("ulif.diceware")`.
+
+By default it provides a `logging.NullHandler` as libraries normally
+do. Other components might add other handlers.
+
"""
import logging
try:
--
GitLab