Installation and Getting Started doc improvements

thobbs · thobbs · commit 24e6334017d3 · 2014-05-08T18:11:17.000-05:00
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -16,7 +16,17 @@ The simplest way to create a :class:`~.Cluster` is like this:
 
     from cassandra.cluster import Cluster
 
-    cluster = Cluster(['10.1.1.3', '10.1.1.4', '10.1.1.5'])
+    cluster = Cluster()
+
+This will attempt to connection to a Cassandra instance on your
+local machine (127.0.0.1).  You can also specify a list of IP
+addresses for nodes in your cluster:
+
+.. code-block:: python
+
+    from cassandra.cluster import Cluster
+
+    cluster = Cluster(['192.168.0.1', '192.168.0.2'])
 
 The set of IP addresses we pass to the :class:`~.Cluster` is simply
 an initial set of contact points.  After the driver connects to one
@@ -33,7 +43,7 @@ behavior in some other way, this is the place to do it:
     from cassandra.polices import DCAwareRoundRobinPolicy
 
     cluster = Cluster(
-        contact_points=['10.1.1.3', '10.1.1.4', '10.1.1.5'],
+        ['10.1.1.3', '10.1.1.4', '10.1.1.5'],
         load_balancing_policy=DCAwareRoundRobinPolicy(local_dc='US_EAST'),
         port=9042)
 
@@ -42,15 +52,19 @@ You can find a more complete list of options in the :class:`~.Cluster` documenta
 
 Instantiating a :class:`~.Cluster` does not actually connect us to any nodes.
 To establish connections and begin executing queries we need a
-:class:`~.Session`, which is created by calling :meth:`.Cluster.connect()`.
+:class:`~.Session`, which is created by calling :meth:`.Cluster.connect()`:
+
+.. code-block:: python
+
+    cluster = Cluster()
+    session = cluster.connect()
+
 The :meth:`~.Cluster.connect()` method takes an optional ``keyspace`` argument
 which sets the default keyspace for all queries made through that :class:`~.Session`:
 
 .. code-block:: python
 
-    from cassandra.cluster import Cluster
-
-    cluster = Cluster(['10.1.1.3', '10.1.1.4', '10.1.1.5'])
+    cluster = Cluster()
     session = cluster.connect('mykeyspace')
 
 
@@ -82,7 +96,14 @@ By default, each row in the result set will be a
 `namedtuple <http://docs.python.org/2/library/collections.html#collections.namedtuple>`_.
 Each row will have a matching attribute for each column defined in the schema,
 such as ``name``, ``age``, and so on.  You can also treat them as normal tuples
-by unpacking them or accessing fields by position:
+by unpacking them or accessing fields by position.  The following three
+examples are equivalent:
+
+.. code-block:: python
+
+    rows = session.execute('SELECT name, age, email FROM users')
+    for row in rows:
+        print row.name, row.age, row.email
 
 .. code-block:: python
 
@@ -93,9 +114,8 @@ by unpacking them or accessing fields by position:
 .. code-block:: python
 
     rows = session.execute('SELECT name, age, email FROM users')
-    names = [row[0] for row in rows]
-    ages = [row[1] for row in rows]
-    emails = [row[2] for row in rows]
+    for row in row:
+        print row[0], row[1], row[2]
 
 If you prefer another result format, such as a ``dict`` per row, you
 can change the :attr:`~.Session.row_factory` attribute.
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -32,8 +32,16 @@ Once the dependencies are installed, simply run::
 
     python setup.py install
 
-(Optional) Non-python Dependencies
-----------------------------------
+Verifying your Installation
+---------------------------
+To check if the installation was successful, you can run:
+
+    python -c 'import cassandra; print cassandra.__version__'
+
+It should print something like "2.0.0".
+
+(*Optional*) Non-python Dependencies
+------------------------------------
 The driver has several **optional** features that have non-Python dependencies.
 
 C Extensions
@@ -113,4 +121,5 @@ just run ``apt-get install python-snappy``.)
 
 Setting SSL
 -----------
-Andrew Mussey has published a thorough guide on `Using SSL with the DataStax Python driver <http://blog.amussey.com/post/64036730812/cassandra-2-0-client-server-ssl-with-datastax-python>`_.
+Andrew Mussey has published a thorough guide on
+`Using SSL with the DataStax Python driver <http://blog.amussey.com/post/64036730812/cassandra-2-0-client-server-ssl-with-datastax-python>`_.
