Finish overhauling the docstrings to numpy format.

[dunshire.git] / src / dunshire / cones.py

diff --git a/src/dunshire/cones.py b/src/dunshire/cones.py
index 764e1daa528d594897a5017164b6c2012ed003cc..905dd8edf7092b83ef7c1275b2a09430f18c10e1 100644 (file)
--- a/src/dunshire/cones.py
+++ b/src/dunshire/cones.py
@@ -1,6 +1,6 @@
 """
 Class definitions for all of the symmetric cones (and their superclass,
-class:`SymmetricCone`) supported by CVXOPT.
+:class:`SymmetricCone`) supported by CVXOPT.
 """
 
 from cvxopt import matrix
@@ -29,6 +29,12 @@ class SymmetricCone:
     dimension : int
         The dimension of this cone.
 
+    Raises
+    ------
+
+    ValueError
+        If you try to create a cone with dimension zero or less.
+
     """
     def __init__(self, dimension):
         """
@@ -434,17 +440,17 @@ class IceCream(SymmetricCone):
 
 
 class SymmetricPSD(SymmetricCone):
-    """
+    r"""
     The cone of real symmetric positive-semidefinite matrices.
 
     This cone has a dimension ``n`` associated with it, but we let ``n``
     refer to the dimension of the domain of our matrices and not the
     dimension of the (much larger) space in which the matrices
     themselves live. In other words, our ``n`` is the ``n`` that appears
-    in the usual notation `S^{n}` for symmetric matrices.
+    in the usual notation :math:`S^{n}` for symmetric matrices.
 
     As a result, the cone ``SymmetricPSD(n)`` lives in a space of dimension
-    ``(n**2 + n)/2)``.
+    :math:`\left(n^{2} + n\right)/2)`.
 
     Examples
     --------