Update READMEs with allow_net_connect documentation

gabrielfalcao · May 27, 2015 · b5c301f · b5c301f
1 parent 10cbee3
commit b5c301f
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -421,6 +421,22 @@ httpretty.disable()
 httpretty.is_enabled().should.be.false
 
 ```
+
+## raising an error if an unregistered endpoint is requested
+
+```python
+import urllib2
+import httpretty
+
+httpretty.enable()
+httpretty.HTTPretty.allow_net_connect = False
+
+httpretty.register_uri(httpretty.GET, 'http://www.google.com', body='OK')
+
+urllib2.urlopen('http://www.google.com')
+urllib2.urlopen('http://www.reddit.com') # raises httpretty.errors.UnmockedError
+```
+
 # Motivation
 
 When building systems that access external resources such as RESTful

diff --git a/README.rst b/README.rst
@@ -418,6 +418,21 @@ checking if is enabled
     httpretty.disable()
     httpretty.is_enabled().should.be.false
 
+raising an error if an unregistered endpoint is requested
+---------------------------------------------------------
+
+.. code:: python
+    import urllib2
+    import httpretty
+
+    httpretty.enable()
+    httpretty.HTTPretty.allow_net_connect = False
+
+    httpretty.register_uri(httpretty.GET, 'http://www.google.com', body='OK')
+
+    urllib2.urlopen('http://www.google.com')
+    urllib2.urlopen('http://www.reddit.com') # raises httpretty.errors.UnmockedError
+
 Motivation
 ==========
 

diff --git a/docs/docs.md b/docs/docs.md
@@ -325,3 +325,18 @@ httpretty.disable()
 httpretty.is_enabled().should.be.false
 
 ```
+
+## raising an error if an unregistered endpoint is requested
+
+```python
+import urllib2
+import httpretty
+
+httpretty.enable()
+httpretty.HTTPretty.allow_net_connect = False
+
+httpretty.register_uri(httpretty.GET, 'http://www.google.com', body='OK')
+
+urllib2.urlopen('http://www.google.com')
+urllib2.urlopen('http://www.reddit.com') # raises httpretty.errors.UnmockedError
+```