Skip to content
Snippets Groups Projects
Commit 7cc28c8b authored by Marco Biasini's avatar Marco Biasini
Browse files

document new behaviour of logging system

parent b21aa572
No related branches found
No related tags found
No related merge requests found
...@@ -14,7 +14,17 @@ OpenStructure has a logging system going beyond what print statements can offer. ...@@ -14,7 +14,17 @@ OpenStructure has a logging system going beyond what print statements can offer.
see :ref:`picking-logging-level`. see :ref:`picking-logging-level`.
:param message: The message to be logged :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:: .. note::
...@@ -125,6 +135,10 @@ To change the current log sink you can use the following methods: ...@@ -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 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. sink when there is only one log sink on the stack.
.. method:: GetCurrentLogSink()
Get the current (active) log sink.
.. _picking-logging-level: .. _picking-logging-level:
Guidelines for picking logging level Guidelines for picking logging level
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment