Commits

codernity committed 5047f8a

Fixed some typos in docs

Comments (0)

Files changed (9)

docs/database_indexes.rst

     .. hint:: In perfect conditions you will be able to store those
         number of unique records without conflicts, in practice you
         will be able to store like ``1200`` records without conflict
-        with 50% probability (for example `birthday problem`_). Lookup
+        with 50% probability (for example `birthday problem`_). Look up
         when conflict occurs is slower because linked list is
-        traversed. More informations about conflicts :ref:`Hash Index
+        traversed. More information about conflicts :ref:`Hash Index
         <internal_hash_index>`.
 
     .. hint:: If you want to have index that searches for let's say
 duplicate keys
     Duplicate keys are stored inside tree structure. So in worst case
     when you have more duplicate keys than ``node_size`` tree will
-    became suboptimal (a half of one node will be always empty)
+    became sub-optimal (a half of one node will be always empty)
 
 
 
     a > 1: 1, None
     a, None
 
-* and optionally body for *make_key* (if you don't provide it, it will be generated automaticlly and set to return key value as it is):
+* and optionally body for *make_key* (if you don't provide it, it will be generated automatically and set to return key value as it is):
     
 ::
 
     if data["a"] > 1:
         return data["a"], None
 
-That's everything you need to know to work with our simplified index creator, you just need to alway provide *name* and *type* in index properties
+That's everything you need to know to work with our simplified index creator, you just need to always provide *name* and *type* in index properties
 and provide body for make_key_value, which has to return always two values (the 2nd has to be a dictionary or None). 
 Here you have some examples and their equivalents in python. Remember that this simplified creator doesn't provide python power,
 so if you want to write more sophisticated index, you will have to learn python.
 Tables, collections...?
 -------------------------
 
-    Ok, I got it, but can I store more than one data type in Database. Is there something like table or collection ?
+    OK, I got it, but can I store more than one data type in Database. Is there something like table or collection ?
 
 .. note::
 

docs/deployment.rst

 Deployment
 ==========
 
-To meake use of CodernityDB (or |CodernityDB-PyClient-link|), you will need just to create global object that will be avaliable to all your application threads etc.
+To make use of CodernityDB (or |CodernityDB-PyClient-link|), you will need just to create global object that will be available to all your application threads etc.
 
 .. seealso:
 
 
 1. Database - a database to use in single process/thread environment
 2. DatabaseTreadSafe - a database to use with threads, readers don't
-   block writters etc. GeventDatabase is 1:1 copy of that database.
+   block writers etc. GeventDatabase is 1:1 copy of that database.
 3. DatabaseSuperThreadSafe - a database to also use with threads, but
    database operations are limited to only one in given time.
 4. CodernityDB-HTTP - a HTTP server version of database, for multi
 compared also with CouchDB views mechanizm. (you would like probably to see :ref:`simple_index`). You can have as much indexes as you want and single record in database can "exists" in more than one index.
 
 Index itself does not store any information except it's
-*metadata*. You don't have to copy full data everytime in indexes,
+*metadata*. You don't have to copy full data every time in indexes,
 because all indexes different than *id* one, are bound with it by
 ``_id`` value, and you can easily get content from that *id* index by
 adding ``with_doc=True`` to your get queries (please refer to
 
 
 
-Currently *Hash* based index (`Hash Table`_ separate chaining version) and *B+Tree* based (`B Plus Tree`_) are avaliable.
+Currently *Hash* based index (`Hash Table`_ separate chaining version) and *B+Tree* based (`B Plus Tree`_) are available.
 
 Both indexes makes huge use of `Sparse files`_.
 
-For more informations about indexes visit :ref:`database_indexes`
+For more information about indexes visit :ref:`database_indexes`
 
 Also please remember that more indexes affects write performance.
 
 Storage needs to save python value to the disk and return the position
 and size to allow Index to save that data. The default implementation
 uses Python marshal_ to serialize and deserialize Python objects
-passed as value into it. So you will be abble to store those object
+passed as value into it. So you will be able to store those object
 that are serializable by marshal_ module.
 
 
 Database operations flow
 ------------------------
 
-During insert into database, incomming data is passed to
+During insert into database, incoming data is passed to
 ``make_key_value`` functions in *all* indexes in order of adding or
 changing them in database.
 On query operations function ``make_key`` is called to get
 Insert
 ^^^^^^
 
-Incomming data is at first processed in *id* index. Then it goes
+Incoming data is at first processed in *id* index. Then it goes
 through ``make_key_value`` method, in next stage the value is stored in
 *storage*, and at last the metadata is stored in *index*.
 Then the procedure is repeated for other indexes.

docs/examples.rst

 ====================
 
 Here you will find some examples, from different projects / ideas. So
-they might miss some *context* informations etc.
+they might miss some *context* information etc.
 
 
 .. _example_indexes:
     Everything can be done through our Index mechanism see :ref:`tables_colections_q`.
 
 How does it compare to MongoDB, CouchDB and other "big" NoSQL databases ?
-    It does not compare. Different purposes, different design, different use case. For some projects it makes sense to use CodernityDB instead of MongoDB, CouchDB and others, for some other not.
+    Different purposes + different design. CodernityDB doesn't have yet any replication engine. However we are sure that there is a place for CodernityDB. Nothing is impossible in CodernityDB, because Index IS a Python class where you can do anything (if you're not a Python user we created :ref:`simple_index`).
 
 Why Python 3 is not supported ?
-    Python 3 introduced many incompatible changes. In case of CodernityDB having working version for 2.x and 3.x series in the same codebase without ugly hacks (big monkey-patching etc.) is almost impossible. If you're interested Python 3 version of CodernityDB contact us. Porting CodernityDB to Python 3.x is not hard. Python 3.x support in fact was never needed. That's why there is no support for it (yet?).
+    Python 3 introduced many incompatible changes. In case of CodernityDB having working version for 2.x and 3.x series in the same code base without ugly hacks (big monkey-patching etc.) is almost impossible. If you're interested Python 3 version of CodernityDB contact us. Porting CodernityDB to Python 3.x is not hard. Python 3.x support in fact was never needed. That's why there is no support for it (yet?).
 
 I want to contribute, what can I do?
     Just fork and create pull request |bitbucket_link|.

docs/how_its_tested.rst

     your hardware). Really **do not** run tests suite on environments
     with less than 4 cpu cores without clock at least 2.5GHz, also if
     you run SSD for personal use, use ramcache instead. Test suite
-    perorms more than 24 000 000 system calls to write, read, lseek.
+    performs more than 24 000 000 system calls to write, read, lseek.
 
 .. note::
     For more details visit or clone our |cdb_repo| and check ``tox.ini`` and
 CodernityDB pure python, NoSQL, fast database
 =============================================
 
-CodernityDB is opensource, pure Python (no 3rd party dependency), fast (really fast check :ref:`speed` if you don't believe in words), multiplatform, schema-less, NoSQL_ database. It has optional support for HTTP server version (|CodernityDB-HTTP-link|), and also Python client library (|CodernityDB-PyClient-link|) that aims to be 100% compatible with embedded version.
+CodernityDB is opensource, pure Python (no 3rd party dependency), fast (really fast check :ref:`speed` if you don't believe in words), multi platform, schema-less, NoSQL_ database. It has optional support for HTTP server version (|CodernityDB-HTTP-link|), and also Python client library (|CodernityDB-PyClient-link|) that aims to be 100% compatible with embedded version.
 
 .. image:: CodernityDB.png
     :align: center
 Quick tutorial 
 ====================
 
-Every single part of codeblock will be full example, so you can copy &
+Every single part of code block will be full example, so you can copy &
 paste it to play with it
 
 
 Ordered data
 ------------
 
-    Ok, but I would to have them in order from range?
+    OK, but I would to have them in order from range?
 
 .. literalinclude:: quick_key_value4.py
    :linenos:
 Update / Delete
 ---------------
 
-    Ok, cool, what about updates ?
+    OK, cool, what about updates ?
 
 Update is very easy, let's say you want to update all documents that
 have ``x % 5 == 0`` and delete those with ``x % 7 == 0``.
     as CodernityDB test suite ?
 
 
-Here you will find some screenshots from the interface:
+Here you will find some screen shots from the interface:
 
 .. image:: CodernityDB_HTTP_new_doc.png
 .. image:: CodernityDB_HTTP_index_overview.png
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.