Another shot at documenting the options module.

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

diff --git a/src/dunshire/options.py b/src/dunshire/options.py
index 03518d812bfb6488b7e382539accd879b8baba73..27752e79e71af02f082367b8b5bd9bfdf4fcf2ee 100644 (file)
--- a/src/dunshire/options.py
+++ b/src/dunshire/options.py
@@ -4,15 +4,24 @@ 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
+"""
+The absolute tolerance used in all "are these numbers equal" and "is
+this number less than (or equal to) that other number" tests.
+"""
+
 
-# 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 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.
 VERBOSE = False
+"""
+The underlying CVXOPT solver can output debug information, and I
+guess, so could we. But we don't want to because it's ugly.
+"""