More "easy" docs work in matrices.py/options.py.

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

diff --git a/src/dunshire/options.py b/src/dunshire/options.py
index 03518d812bfb6488b7e382539accd879b8baba73..434915423895a2ee2587af27d55df93b267689ad 100644 (file)
--- a/src/dunshire/options.py
+++ b/src/dunshire/options.py
@@ -2,17 +2,24 @@
 A place to collect the various options that "can be passed to the
 underlying engine." Just kidding, they're constants and you can't
 change them. But this makes the user interface real simple.
-"""
 
-# The absolute tolerance used in all "are these numbers equal" and "is
-# this number less than (or equal to) that other number" tests.
-ABS_TOL = 1e-7
+.. data:: ABS_TOL
 
-# The default output format for floating point numbers. It has been
-# chosen to match the ABS_TOL, in the sense that if x != y, then they
-# would not appear different when printed.
-FLOAT_FORMAT = '%.7f'
+    The absolute tolerance used in all "are these numbers equal" and "is
+    this number less than (or equal to) that other number" tests.
+
+.. data:: FLOAT_FORMAT
+
+    The default output format for floating point numbers. It has been
+    chosen to match the ``ABS_TOL``, in the sense that if ``x != y``,
+    then they would not appear different when printed.
 
-# The underlying CVXOPT solver can output debug information, and I
-# guess, so could we. But we don't want to because it's ugly.
+.. data:: VERBOSE
+
+    The underlying CVXOPT solver can output debug information, and I
+    guess, so could we. But we don't want to because it's ugly.
+
+"""
+ABS_TOL = 1e-7
+FLOAT_FORMAT = '%.7f'
 VERBOSE = False