Changeset 4288 for waeup

Timestamp:

14 Jun 2009, 13:27:04 (16 years ago)

Author:

uli

Message:

More sphinx aware tagging.

File:

• waeup/branches/ulif-rewrite/src/waeup/csvfile/README.txt (modified) (7 diffs)

waeup/branches/ulif-rewrite/src/waeup/csvfile/README.txt

@@ -20 +20 @@
 ================
 
+:class:`CSVFile`
+----------------
+
 .. class:: CSVFile(filepath)
 
@@ -78 +81 @@
 
       Get a sorted list of header fields in the wrapped CSV file.
+
+
+:func:`getCSVFile`
+----------------------
 
 .. function:: getCSVFile(filepath)
@@ -219 +226 @@
 
 If we want to get a wrapper best suited for our purposes, we can also
-use the `getCSVFile` function:
+use the :func:`getCSVFile` function:
 
     >>> from waeup.csvfile.csvfile import getCSVFile
@@ -258 +265 @@
 .. _getcsvfiledecision:
 
-How `getCSVFile()` decides which wrapper to use
------------------------------------------------
-
-Apparently, getCSVFile performes some magic: given a certain CSV file,
-it decides which one of all registered wrappers suits the file best.
+
+How :func:`getCSVFile` decides which wrapper to use
+---------------------------------------------------
+
+Apparently, :func:`getCSVFile` performes some magic: given a certain
+CSV file, it decides which one of all registered wrappers suits the
+file best.
 
 This decision is based on a score, which is computed as shown below
@@ -359 +368 @@
 The special things here are:
 
-* Derive from `CSVFile`
-
-  `getCSVFile()` looks only for classes that are derived from
-  `CSVFile`. So if you want your wrapper to be found by this function,
-  derive from `CSVFile`.
-
-  As `CSVFile` is an adapter, also our custom wrapper will become one
-  (adapting strings):
+* Derive from :class:`CSVFile`
+
+  :func:`getCSVFile` looks only for classes that are derived from
+  :class:`CSVFile`. So if you want your wrapper to be found by this function,
+  derive from :class:`CSVFile`.
+
+  As :class:`CSVFile` is an adapter, also our custom wrapper will
+  become one (adapting strings):
 
      >>> ICustomCSVFile(path)
@@ -401 +410 @@
 --------------------------------------------
 
-The type of a CSVFile is determined by the interfaces it provides.
+The type of a :class:`CSVFile` is determined by the interfaces it
+provides.
 
 If we want to get a wrapper that also guarantees to support certain
@@ -543 +553 @@
 
 We can also create an importer without knowing the type of CSV file
-before, using the `getCSVFile` function:
+before, using the :func:`getCSVFile` function:
 
     >>> from waeup.csvfile import getCSVFile