Minor doc updates and fixes

Fixed syntactic typo in eval.py

diff --git a/t/doc/config.rst b/t/doc/config.rst
index 57d58c1d226ff96c066dd458baef56f944699e14..5a122599cec0df6671963b83ab16cb3ea9a4fb48 100644 (file)
--- a/t/doc/config.rst
+++ b/t/doc/config.rst
@@ -1,3 +1,5 @@
+.. _config:
+
 Moe configuration
 =================
 

diff --git a/t/doc/index.rst b/t/doc/index.rst
index c0ef80164715e4b96afd2f43e9faff3e5bf0f84a..ac343c9ed05a9a521a34b93ee8007b0ac5b52360 100644 (file)
--- a/t/doc/index.rst
+++ b/t/doc/index.rst
@@ -7,9 +7,10 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
-   timeline.rst
-   log.rst
-   config.rst
+   timeline
+   eval
+   log
+   config
 
 Indices and tables
 ==================

diff --git a/t/doc/log.rst b/t/doc/log.rst
index c25ded4457b219dc6c71d2e6a5a2e82e51013d66..dca955a3d10369870dc0a11750138ffe2a8e94db 100644 (file)
--- a/t/doc/log.rst
+++ b/t/doc/log.rst
@@ -1,11 +1,13 @@
+.. _log:
+
 Moe Logging
 ===========
 
-One `Loggers` object is created for Eval, initializing 4 subloggers (see class description). 
+`Loggers` is a collection of logggers for :class:`~moe.eval.Eval`, initializing 4 subloggers (see class description). 
 
-Use as `e.log.debug(...)` for both test and main log, `e.log.user.debug(...)` for `user` and other logs.
+Use as `e.log.debug(...)` for main log that goes both to `test` and `main` log, 
+`e.log.test.debug(...)` for individual logs.
 
 .. autoclass:: moe.log.Loggers
        :members:
-       :member-order: bysource
 

diff --git a/t/doc/timeline.rst b/t/doc/timeline.rst
index 37a2f5e65ce63c23a0f6d60d0fec40c41211b6d4..3c36ea7577266f19b2ee23d54c2781ea32319e75 100644 (file)
--- a/t/doc/timeline.rst
+++ b/t/doc/timeline.rst
@@ -1,3 +1,5 @@
+.. _timeline:
+
 Evaluation timeline
 ====================
 

diff --git a/t/moe/eval.py b/t/moe/eval.py
index c92ce8a753c06d2bb0c2b9885ddefc0370f3a444..9a964ffb9a269f98bf101976ef02d9feeab70564 100644 (file)
--- a/t/moe/eval.py
+++ b/t/moe/eval.py
@@ -81,18 +81,18 @@ class Eval:
            raise moe.MoeError, "Cannot create %s: %s" % (test, err.strerror)
 
     def debug_dump_config(self):
-      "Dumps at level DDEBUG and only compiles the dump if main level low enough."
+      "Dumps config at level DDEBUG (only compiles the dump if main level is low enough)."
       if self.log.level <= 5:
-       self.log.ddebug('****** Config dump: ******'))
+       self.log.ddebug('****** Config dump: ******')
        self.log.ddebug(self.config.dump('**** '))
-       self.log.ddebug('**************************'))
+       self.log.ddebug('**************************')
 
     def debug_dump_pipe(self, pipe):
-      "Dumps at level DDEBUG and only compiles the dump if main level low enough."
+      "Dumps pipeline `pipe` at level DDEBUG (only compiles the dump if main level low enough)."
       if self.log.level <= 5:
-       self.log.ddebug('****** Pipeline %r dump: ******'%pipe,name))
+       self.log.ddebug('****** Pipeline %r dump: ******'%pipe,name)
        self.log.ddebug(pipe.dump(prefix='**** '))
-       self.log.ddebug('**************************'))
+       self.log.ddebug('**************************')
 
 #TODO ...
     def init_task(self):

diff --git a/t/moe/log.py b/t/moe/log.py
index 1660a028b70441a23595750f988aa8d30136a20f..19b475c70d9d181dc83d81b51cfac69fe91ad715 100644 (file)
--- a/t/moe/log.py
+++ b/t/moe/log.py
@@ -18,7 +18,7 @@ class Loggers(Logger):
     per-test log, initially no handler, to be directed to file like `{TEST}.log`
 
   .. note:: Currently, the logs and fd's get never closed. 
-  .. note:: Currently, the `Loggers.open_eval_log` changes fd's 1 and 2 by default, this is a global change.
+  .. warning:: `Loggers.open_eval_log` changes global fd's 1 and 2 by default.
   """
   def __init__(self):
     "Initialize loggers as described in class description."