[tauruslib-devel] [PATCH 2/8] Add documentation for taurusremotelogmonitor

[mrosanes <mro...@ce...>]

Some of the launchers are not documented. This is the case
of taurusremotelogmonitor.

Add help description for taurusremotelogmonitor and class
docstring for QRemoteLoggingTableModel.
---
 lib/taurus/qt/qtgui/table/qlogtable.py | 5 +++--
 scripts/taurusremotelogmonitor         | 1 +
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/lib/taurus/qt/qtgui/table/qlogtable.py b/lib/taurus/qt/qtgui/table/qlogtable.py
index 56e4d2c..2e936de 100644
--- a/lib/taurus/qt/qtgui/table/qlogtable.py
+++ b/lib/taurus/qt/qtgui/table/qlogtable.py
@@ -26,7 +26,8 @@
 """This module provides Qt table widgets which display logging messages from the
 python :mod:`logging` module"""
 
-__all__ = ["QLoggingTableModel", "QLoggingTable", "QLoggingWidget"]
+__all__ = ["QLoggingTableModel", "QLoggingTable", "QLoggingWidget",
+           "QRemoteLoggingTableModel"]
 
 __docformat__ = 'restructuredtext'
 
@@ -308,7 +309,7 @@ class _LogRecordStreamHandler(LogRecordStreamHandler):
 
 
 class QRemoteLoggingTableModel(QLoggingTableModel):
-
+    """A remote Qt table that displays the taurus logging messages"""
     def connect_logging(self, host='localhost',
                 port=logging.handlers.DEFAULT_TCP_LOGGING_PORT,
                 handler=_LogRecordStreamHandler):
diff --git a/scripts/taurusremotelogmonitor b/scripts/taurusremotelogmonitor
index ff02f46..e8435a3 100755
--- a/scripts/taurusremotelogmonitor
+++ b/scripts/taurusremotelogmonitor
@@ -46,6 +46,7 @@ def main():
                  "error, warning/warn, info, debug, trace [default: debug]."
 
     parser = optparse.OptionParser()
+    parser.set_description("Table that displays the taurus logging messages")
     parser.add_option("-g", "--gui", dest="gui", default=True,
                       action="store_true", help=help_gui)
     parser.add_option("-c", "--console", dest="gui",
-- 
1.8.3.4