Commits

Don Spaulding  committed 3c3408f

Englishify the API docs.

  • Participants
  • Parent commits a8de95f

Comments (0)

Files changed (1)

File docs/api.rst

 API docs
 ========
 
-Here you will find API docs. If you're python user you will probably
-understand it. In other case you should visit:
+This page is an API reference.  It describes usage of the embedded version of
+CodernityDB. If you are unfamiliar with Python, you may want to use 
+|CodernityDB-HTTP-link| instead.
+
+If you're sure you want the embedded version, you may still want to review
+some higher-level documentation.  Such as:
 
 - :ref:`database_operations_description`
 - :ref:`design`
 - :ref:`quick_tutorial`
 
-And you probably want to use |CodernityDB-HTTP-link| instead this embedded version.
 
 Database
 --------
 
 .. note::
-    Please refer to :ref:`database_operations_description` for general description
+    A more descriptive explanation of Database operations is available at: :ref:`database_operations_description`.
 
 
 Standard
 ^^^^^^^^^^^^^^^^^^^
 
 .. note::
-    Please refer to :ref:`internal_hash_index` for description
+    A more descriptive explanation of Hash Indexes is available at: :ref:`internal_hash_index`.
 
 .. automodule:: CodernityDB.hash_index
     :members:
 ^^^^^^^^^^^^^^^^^^^^^
 
 .. note::
-    Please refer to :ref:`internal_tree_index` for description
+    A more descriptive explanation of B+Tree Indexes is available at: :ref:`internal_tree_index`.
 
 .. automodule:: CodernityDB.tree_index
     :members: