[doc] fix rql/debugging.rst and server.__init__ docstrings stable
authorNicolas Chauvat <nicolas.chauvat@logilab.fr>
Tue, 15 Mar 2011 09:41:45 +0100
branchstable
changeset 7080 a828feedc164
parent 7075 4751d77394b1
child 7081 6beb7f1e05fa
[doc] fix rql/debugging.rst and server.__init__ docstrings
doc/book/en/annexes/rql/debugging.rst
server/__init__.py
--- a/doc/book/en/annexes/rql/debugging.rst	Fri Mar 11 09:47:09 2011 +0100
+++ b/doc/book/en/annexes/rql/debugging.rst	Tue Mar 15 09:41:45 2011 +0100
@@ -33,7 +33,7 @@
 Enable verbose output
 ~~~~~~~~~~~~~~~~~~~~~
 
-It may be interested to enable a verboser output to debug your RQL statements:
+To debug your RQL statements, it can be useful to enable a verbose output:
 
 .. sourcecode:: python
 
--- a/server/__init__.py	Fri Mar 11 09:47:09 2011 +0100
+++ b/server/__init__.py	Tue Mar 15 09:41:45 2011 +0100
@@ -62,9 +62,9 @@
         DEBUG |= debugmode
 
 class debugged(object):
-    """repository debugging context manager / decorator
+    """Context manager and decorator to help debug the repository.
 
-    Can be used either as a context manager:
+    It can be used either as a context manager:
 
     >>> with debugged(server.DBG_RQL | server.DBG_REPO):
     ...     # some code in which you want to debug repository activity,
@@ -77,8 +77,8 @@
     ...     # some code in which you want to debug repository activity,
     ...     # seing information about RQL being executed an repository events
 
-    debug mode will be reseted at its original value when leaving the "with"
-    block or the decorated function
+    The debug mode will be reset to its original value when leaving the "with"
+    block or the decorated function.
     """
     def __init__(self, debugmode):
         self.debugmode = debugmode