John Mulligan avatar John Mulligan committed df6804a

configreader: sphinx rst file and doc tweaks

Comments (0)

Files changed (3)

doc/source/index.rst

 
    vanity_cli
    vanity_commander
+   vanity_configreader
 
 Indices and tables
 ==================

doc/source/vanity_configreader.rst

+
+:mod:`vanity.configreader` -- Simple Configration File Reading
+================================================================
+
+.. automodule:: vanity.configreader
+   :members:

vanity/configreader.py

 """A very simple config file reader
 
 Similar to the ConfigParser module in the python standard libary,
-only extemely simple, without any advanced interpolation or
-type conversions. The ConfigReader class implements absolutely
-no funny business with regard to value content.
+with a simplified interface. Simple, without any interpolation or
+automatic type conversions. The ConfigReader class implements absolutely
+no funny business with regard to the strings in the configuration file.
+The ConfigReader class is read only.
 
 In addition to not treating the values with any magic, the 
 ConfigReader class retains the order of the items in every
 section, in case the application needs configuration items
 in the order specified by the user.
 
-If you want interpolation, build a layer on top of ConfigReader
-or use the standard library. :-)
+ConfigReader is designed to be very simple to subclass which
+should make adding  interpolation, or other features easier
+than removing unwanted features from the standard library
+ConfigParser. At least, thats the general idea. :-)
 """
 
 
         names. If that value does not exist in the configuration
         return the value of default.
 
-        NOTE: This operates the same as dict.get(...) and unlike 
+        NOTE: This operates like dict.get(...) and unlike 
         ConfigParser.get(...). Since this class does not do any
         interpolation, the only way to get a None value is if
         the key does not exist.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.