Fix version and some docs omissions

sigmavirus24 · sigmavirus24 · commit fce7cea1f034 · 2013-03-23T16:50:30.000-04:00
diff --git a/docs/examples/iterators.rst b/docs/examples/iterators.rst
@@ -20,9 +20,6 @@ The problem is that you will then have to reiterate over all of the users each
 time you want to get the new users. You have two approaches you can take to 
 avoid this with :class:`GitHubIterator <github3.structs.GitHubIterator>`.
 
-The First Approach
-------------------
-
 You can not call the method directly in the for-loop and keep the iterator as 
 a separate reference like so:
 
@@ -33,6 +30,9 @@ a separate reference like so:
     for u in i:
         add_user_to_database(u)
 
+The First Approach
+------------------
+
 Then after your first pass through your ``GitHubIterator`` object will have an 
 attribute named ``etag``. After you've added all the currently existing users 
 you could do the following to retrieve the new users in a timely fashion:
@@ -48,6 +48,24 @@ you could do the following to retrieve the new users in a timely fashion:
 
         time.sleep(120)  # Sleep for 2 minutes
 
-If there are no new users, this won't impact your ratelimit at all. This 
-mimics the ability to conditionally refresh data on almost all other objects 
-in github3.py.
+The Second Approach
+-------------------
+
+.. code-block:: python
+
+    etag = i.etag
+    # Store this somewhere
+
+    # Later when you start a new process or go to check for new users you can 
+    # then do
+
+    i = g.iter_all_users(etag=etag)
+
+    for u in i:
+        add_user_to_database(u)
+
+------
+
+If there are no new users, these approaches won't impact your ratelimit at 
+all. This mimics the ability to conditionally refresh data on almost all other 
+objects in github3.py.
diff --git a/docs/structs.rst b/docs/structs.rst
@@ -1,19 +1,22 @@
 .. module:: github3
 .. module:: github3.structs
 
-Structures developed for github3.py
-===================================
+Structures
+==========
 
-As of right now, there exists only one class in this file, and it is of only
-limited importance to users of github3.py. The :class:`GitHubIterator` class 
-is used to return the results of calls to almost all of the calls to ``iter_`` 
-methods on objects. When conditional refreshing was added to objects, there 
-was a noticable gap in having conditional calls to those ``iter_`` methods.  
-GitHub provides the proper headers on those calls, but there was no easy way 
-to add that to what github3.py returned so it could be used properly. This was 
-the best compromise - an object the behaves like an iterator regardless but 
-can also be ``refresh``\ ed to get results since the last request 
-conditionally.
+Developed for github3.py
+------------------------
+
+As of right now, there exists only one class in this section, and it is of 
+only limited importance to users of github3.py. The :class:`GitHubIterator` 
+class is used to return the results of calls to almost all of the calls to 
+``iter_`` methods on objects. When conditional refreshing was added to 
+objects, there was a noticable gap in having conditional calls to those 
+``iter_`` methods.  GitHub provides the proper headers on those calls, but 
+there was no easy way to add that to what github3.py returned so it could be 
+used properly. This was the best compromise - an object the behaves like an 
+iterator regardless but can also be ``refresh``\ ed to get results since the 
+last request conditionally.
 
 Objects
 -------
diff --git a/github3/__init__.py b/github3/__init__.py
@@ -13,7 +13,7 @@
 __author__ = 'Ian Cordasco'
 __license__ = 'Modified BSD'
 __copyright__ = 'Copyright 2012-2013 Ian Cordasco'
-__version__ = '0.5.3'
+__version__ = '0.6.0.b'
 
 from github3.api import *
 from github3.github import GitHub, GitHubEnterprise, GitHubStatus
