From: Michael Orlitzky <michael@orlitzky.com>
Date: Mon, 10 Oct 2016 17:44:14 +0000 (-0400)
Subject: Another shot at documenting the options module.
X-Git-Tag: 0.1.0~171
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=fa5b8f037ddca2c53a19186fac1aebf3d24aec3d;p=dunshire.git

Another shot at documenting the options module.
---

diff --git a/src/dunshire/options.py b/src/dunshire/options.py
index 4349154..27752e7 100644
--- a/src/dunshire/options.py
+++ b/src/dunshire/options.py
@@ -2,24 +2,26 @@
 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.
+"""
 
-.. data:: ABS_TOL
-
-    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
+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.
 
-.. data:: VERBOSE
+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.
 
-"""
-ABS_TOL = 1e-7
-FLOAT_FORMAT = '%.7f'
 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.
+"""