Review: a few fixes
[pyi2ncommon] / src / cnfvar / binary.py
index 3d71c19..63311cc 100644 (file)
 """
 binary: wrappers around binaries that work with the CNF store.
 
-Featuring
-- CnfBinary: stateless class that can be used to invoke the different binaries
-in a Python-friendly way.
+Featuring:
+    - CnfBinary: stateless class that can be used to invoke the different binaries
+      in a Python-friendly way.
 
 .. note:: It is written as a class on purpose for it to be easily extended to
-support invoking non-local binaries, but methods are all class methods since
-the class is stateless.
+          support invoking non-local binaries, but methods are all class methods since
+          the class is stateless.
+
+.. seealso:: Overview Diagram linked to from doc main page
 
 .. codeauthor:: Intra2net
 """
@@ -38,7 +40,7 @@ import shlex
 import html
 import re
 
-log = logging.getLogger("pyi2ncommon.cnfvar.store")
+log = logging.getLogger("pyi2ncommon.cnfvar.binary")
 
 #: default get_cnf binary
 BIN_GET_CNF = "/usr/intranator/bin/get_cnf"
@@ -48,7 +50,7 @@ BIN_SET_CNF = "/usr/intranator/bin/set_cnf"
 ENCODING = "latin1"
 
 
-class CnfBinary(object):
+class CnfBinary:
     """Provide wrappers around the multiple binaries to handle the CNF store."""
 
     @classmethod
@@ -93,7 +95,7 @@ class CnfBinary(object):
         :rtype: str
 
         .. note:: being a wrapper, this function does not do anything extra
-        like checking if arnied is running or waiting for generate.
+                  like checking if arnied is running or waiting for generate.
         """
         if name is None and instance is not None:
             raise ValueError("cannot pass `instance` without a `name`")
@@ -137,7 +139,7 @@ class CnfBinary(object):
         :raises: :py:class:`SetCnfException` in case the binary errors out
 
         .. note:: being a wrapper, this function does not do anything extra
-        like checking if arnied is running or waiting for generate.
+                  like checking if arnied is running or waiting for generate.
         """
         if input_str is None and input_file is None:
             raise ValueError("Need to pass either a string or a file")