From: Christian Herdtweck <christian.herdtweck@intra2net.com>
Date: Fri, 12 Feb 2016 14:00:15 +0000 (+0100)
Subject: fix sphinx todo/seealso flags
X-Git-Tag: v1.2~31
X-Git-Url: http://developer.intra2net.com/git/?a=commitdiff_plain;h=2713b3524ef844b42f69f71daa8e02fd290cbb32;p=pyi2ncommon

fix sphinx todo/seealso flags
---

diff --git a/src/log_helpers.py b/src/log_helpers.py
index d51e641..c275b13 100644
--- a/src/log_helpers.py
+++ b/src/log_helpers.py
@@ -33,9 +33,9 @@ Further ideas: ::
 * try to find out module that calls I2nLogger constructor to provide a good
   default value for name (finding out the current module is a pain in the a..)
 
-..todo:: create unittests from test_* functions at bottom
-..todo:: think about how to allow different levels per handler
-..todo:: do not limit logs by line numbers but by disc size? Warn when at 50%,
+.. todo:: create unittests from test_* functions at bottom
+.. todo:: think about how to allow different levels per handler
+.. todo:: do not limit logs by line numbers but by disc size? Warn when at 50%,
          75%, 90%, 99% of limit?
 
 .. codeauthor:: Intra2net
diff --git a/src/log_read.py b/src/log_read.py
index 97bb917..3bcb054 100644
--- a/src/log_read.py
+++ b/src/log_read.py
@@ -22,7 +22,7 @@ Basic Functionality (class :py:class:`IterativeReader`:)
 Runs stat in a loop to find out whether file size has changed. Then reads the
 new data and forwards that
 
-..todo:: Want to also use lsof to find out whether file/pipe/socket was closed,
+.. todo:: Want to also use lsof to find out whether file/pipe/socket was closed,
          so can return from read loop
 
 :py:class:`LineReader` takes output of :py:class:`IterativeReader` and returns
@@ -31,7 +31,7 @@ it line-wise as is normal for log files
 :py:class:`LogParser` takes those lines and tries to parse them into fields
 like date, time, module name, urgency and message.
 
-..todo:: auto-detect log line layout
+.. todo:: auto-detect log line layout
 
 .. codeauthor:: Intra2net
 """
diff --git a/test/test_follow.py b/test/test_follow.py
index 5e6c778..c2aabdf 100644
--- a/test/test_follow.py
+++ b/test/test_follow.py
@@ -21,10 +21,10 @@
 This is a little more involved since in order to test properly, need a second
 thread that writes to file/socket/stdout
 
-..todo:: as in log_read_unittest: disable buffering in LogFileWriter
+.. todo:: as in log_read_unittest: disable buffering in LogFileWriter
 
-DEPRECATED
-(at least for files see log_read; may still be usefull for pipes/sockets)
+.. warn:: DEPRECATED (at least for files see log_read; may still be useful for
+          pipes/sockets)
 
 .. codeauthor:: Intra2net
 """