Adding docs and changelog

revsys · May 23, 2015 · 159f6b4 · 159f6b4
1 parent 8bf6675
commit 159f6b4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -1,6 +1,11 @@
 Changes
 =======
 
+version 1.0.2 - May 23rd, 2015
+------------------------------
+  - Actually fixing README by moving README.md to README.rst
+  - Added docs for assertNuMQueriesLessThan()
+
 version 1.0.1 - May 23rd, 2015
 ------------------------------
   - Fixing README markdown on PyPI issue

diff --git a/README.rst b/README.rst
@@ -252,7 +252,13 @@ Django provides
 which is great when your code generates generates a specific number of
 queries. However, if due to the nature of your data this number can vary
 you often don't attempt to ensure the code doesn't start producing a ton
-more queries than you expect.
+more queries than you expect::
+
+    def test_something_out(self):
+
+        with self.assertNumQueriesLessThan(7):
+            self.get('some-view-with-6-queries')
+
 
 **NOTE:** This isn't possible in versions of Django prior to 1.6, so the
 context will run your code and assertions and issue a warning that it