From 7cc28c8b86f34dd2f9dfe1febf582cd0717fc66c Mon Sep 17 00:00:00 2001
From: Marco Biasini <marco.biasini@unibas.ch>
Date: Thu, 13 Oct 2011 08:46:26 +0200
Subject: [PATCH] document new behaviour of logging system
---
modules/base/doc/logging.rst | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/modules/base/doc/logging.rst b/modules/base/doc/logging.rst
index 1a81d4794..2637bd9e2 100644
--- a/modules/base/doc/logging.rst
+++ b/modules/base/doc/logging.rst
@@ -14,7 +14,17 @@ OpenStructure has a logging system going beyond what print statements can offer.
see :ref:`picking-logging-level`.
:param message: The message to be logged
- :type message: str
+ :type message: convertible to string
+
+ Similar to the built-int print function, several arguments can be passed to
+ the logging functions. The arguments will be converted to string and then
+ concatenated together, separated by space. For example:
+
+ .. code-block:: python
+
+ LogMessage('here be numbers', 1, 2)
+
+ will be converted to 'here be numbers 1 2'.
.. note::
@@ -125,6 +135,10 @@ To change the current log sink you can use the following methods:
Change the log sink back to the previous one. It is an error to pop the log
sink when there is only one log sink on the stack.
+.. method:: GetCurrentLogSink()
+
+ Get the current (active) log sink.
+
.. _picking-logging-level:
Guidelines for picking logging level
--
GitLab