fixed references and add more doc

quatrope · May 16, 2018 · 76ebdec · 76ebdec
1 parent d0bb7dc
commit 76ebdec
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 15 deletions.
diff --git a/doc/source/api/madm/madm.rst b/doc/source/api/madm/madm.rst
@@ -15,3 +15,4 @@
     closeness
     moora
     electre
+    simus
diff --git a/doc/source/api/madm/simus.rst b/doc/source/api/madm/simus.rst
@@ -0,0 +1,6 @@
+``skcriteria.madm.simus`` module
+================================
+
+.. automodule:: skcriteria.madm.simus
+    :members:
+    :show-inheritance:
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -29,11 +29,12 @@
 import skcriteria
 
 # modules to mock in readthedocs
-MOCK_MODULES = ["numpy", "scipy",
-                "matplotlib", "matplotlib.pyplot",
-                "matplotlib.cm", "matplotlib.patches",
-                "matplotlib.spines", "matplotlib.projections.polar",
-                "matplotlib.projections", "matplotlib.path"]
+MOCK_MODULES = []
+#~ ["numpy", "scipy",
+                #~ "matplotlib", "matplotlib.pyplot",
+                #~ "matplotlib.cm", "matplotlib.patches",
+                #~ "matplotlib.spines", "matplotlib.projections.polar",
+                #~ "matplotlib.projections", "matplotlib.path"]
 
 # -- General configuration ------------------------------------------------
 
@@ -72,7 +73,7 @@
 
 # General information about the project.
 project = skcriteria.NAME
-copyright = u'2015-2016-2017, Juan B. Cabral - Nadia A. Luczywo'
+copyright = u'2015-2016-2017-2018, Juan B. Cabral - Nadia A. Luczywo'
 author = u'Juan BC'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/doc/source/install.rst b/doc/source/install.rst
@@ -4,7 +4,7 @@
 Installing scikit-criteria
 ==========================
 
-The easiest way to install scikit-learn is using ``pip`` ::
+The easiest way to install scikit-criteria is using ``pip`` ::
 
     pip install -U scikit-criteria
 
@@ -35,5 +35,5 @@ Canopy and Anaconda for all supported platforms
 `Canopy
 <https://www.enthought.com/products/canopy>`_ and `Anaconda
 <https://www.continuum.io/downloads>`_ both ship a recent
-version of scikit-learn, in addition to a large set of scientific python
+version of Python, in addition to a large set of scientific python
 library for Windows, Mac OSX and Linux.
diff --git a/skcriteria/madm/electre.py b/skcriteria/madm/electre.py
@@ -225,6 +225,7 @@ class ELECTRE1(DecisionMaker):
     .. [3] Tzeng, G. H., & Huang, J. J. (2011). Multiple attribute decision
        making: methods and applications. CRC press.
 
+
     """
 
     def __init__(self, p=.65, q=.35, mnorm="sum", wnorm="sum", njobs=None):
@@ -269,3 +270,11 @@ def q(self):
 
         """
         return self._q
+
+    @property
+    def njobs(self):
+        """How many cores to use to solve the linear programs and the second
+        method. By default all the availables cores are used.
+
+        """
+        return self._njobs
diff --git a/skcriteria/madm/simus.py b/skcriteria/madm/simus.py
@@ -252,8 +252,8 @@ class SIMUS(DecisionMaker):
         The two methods are executed always.
 
     solver : str, default="pulp"
-        Whic solver to use to solve the undelying linear programs. The full
-        list are available in :py:dict:`skcriteria.utils.lp.SOLVERS`
+        Which solver to use to solve the undelying linear programs. The full
+        list are available in `skcriteria.utils.lp.SOLVERS`
 
     njobs : int, default=None
         How many cores to use to solve the linear programs and the second
@@ -292,16 +292,16 @@ class SIMUS(DecisionMaker):
           - **doms**: Total dominance matrix of the 2nd. method.
           - **dom_by_crit**: Dominance by criteria of the 2nd method.
 
-
     References
     ----------
 
     .. [1] Munier, N. (2011). A strategy for using multicriteria analysis in
-    decision-making: a guide for simple and complex environmental projects.
-    Springer Science & Business Media.
+       decision-making: a guide for simple and complex environmental projects.
+       Springer Science & Business Media.
     .. [2] Munier, N., Carignano, C., & Alberto, C. UN MÉTODO DE PROGRAMACIÓN
-    MULTIOBJETIVO. Revista de la Escuela de Perfeccionamiento en Investigación
-    Operativa, 24(39).
+       MULTIOBJETIVO. Revista de la Escuela de Perfeccionamiento en
+       Investigación Operativa, 24(39).
+
 
     """
 
@@ -336,10 +336,18 @@ def solve(self, ndata, b):
 
     @property
     def solver(self):
+        """Which solver to use to solve the undelying linear programs. The full
+        list are available in `skcriteria.utils.lp.SOLVERS`
+
+        """
         return self._solver
 
     @property
     def njobs(self):
+        """How many cores to use to solve the linear programs and the second
+        method. By default all the availables cores are used.
+
+        """
         return self._njobs