Fix docstrings alignment to 0.2.0

Author: bgoujaud

PEPit/function.py

@@ -261,7 +261,7 @@ def add_psd_matrix(self, matrix_of_expressions):
         Store a new matrix of :class:`Expression`\s that we enforce to be positive semidefinite.
 
         Args:
-            matrix_of_expressions (Iterable of Iterable of Expression): a square matrix of :class:`Expression`.
+            matrix_of_expressions (2D ndarray of Expression): a square matrix of :class:`Expression`.
 
         Raises:
             AssertionError: if provided matrix is not a square matrix.

PEPit/pep.py

@@ -141,7 +141,7 @@ def add_psd_matrix(self, matrix_of_expressions):
         Store a new matrix of :class:`Expression`\s that we enforce to be positive semidefinite.
 
         Args:
-            matrix_of_expressions (Iterable of Iterable of Expression): a square matrix of :class:`Expression`.
+            matrix_of_expressions (2D ndarray of Expression): a square matrix of :class:`Expression`.
 
         Raises:
             AssertionError: if provided matrix is not a square matrix.

PEPit/psd_matrix.py

@@ -8,7 +8,7 @@ class PSDMatrix(object):
     A :class:`PSDMatrix` encodes a square matrix of :class:`Expression` objects that is constrained to be symmetric PSD.
 
     Attributes:
-        matrix_of_expressions (Iterable of Iterable of Expression): a square matrix of :class:`Expression` objects.
+        matrix_of_expressions (2D ndarray of Expression): a square matrix of :class:`Expression` objects.
         shape (tuple of ints): the shape of the underlying matrix of :class:`Expression` objects.
         _value (2D ndarray of floats): numerical values of :class:`Expression` objects
                                        obtained after solving the PEP via SDP solver.
@@ -22,11 +22,12 @@ class PSDMatrix(object):
 
     Example:
         >>> # Defining t <= sqrt(expr) for a given expression expr.
+        >>> import numpy as np
         >>> from PEPit import Expression
         >>> from PEPit import PSDMatrix
         >>> expr = Expression()
         >>> t = Expression()
-        >>> psd_matrix = PSDMatrix(matrix_of_expressions=[[expr, t], [t, 1]])
+        >>> psd_matrix = PSDMatrix(matrix_of_expressions=np.array([[expr, t], [t, 1]]))
         >>> # The last line means that the matrix [[expr, t], [t, 1]] is constrained to be PSD.
         >>> # This is equivalent to det([[expr, t], [t, 1]]) >= 0, i.e. expr - t^2 >= 0.
 
@@ -40,7 +41,7 @@ def __init__(self, matrix_of_expressions):
         :class:`PSDMatrix` objects are instantiated via the following argument.
 
         Args:
-            matrix_of_expressions (Iterable of Iterable of Expression): a square matrix of :class:`Expression`.
+            matrix_of_expressions (2D ndarray of Expression): a square matrix of :class:`Expression`.
 
         Instantiating the :class:`PSDMatrix` objects of the first example can be done by