summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Foord <michael@voidspace.org.uk>2012-01-27 01:03:53 +0000
committerMichael Foord <michael@voidspace.org.uk>2012-01-27 01:03:53 +0000
commitfec3fd6b1369455094a93725a7c9bcce290c0260 (patch)
tree2d5db84ccae4c321da39110a25aad3b9ef619f4b
parent5c293056d93b2ccdf2aa4bbce4f107b47e95a0d8 (diff)
downloadmock-fec3fd6b1369455094a93725a7c9bcce290c0260.tar.gz
Minor doc updates
-rw-r--r--docs/getting-started.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/getting-started.txt b/docs/getting-started.txt
index 4e03577..c679992 100644
--- a/docs/getting-started.txt
+++ b/docs/getting-started.txt
@@ -28,14 +28,16 @@ Using Mock
Mock Patching Methods
---------------------
-``Mock`` objects can be used for:
+:class:`Mock` objects can be used for:
* Patching methods
* Recording method calls on objects
+For example, you might want to replace a method on an object to check that
+it is called with the correct arguments by another part of the system:
+
.. doctest::
- >>> from mock import Mock
>>> real = SomeClass()
>>> real.method = Mock(name='method')
>>> real.method(3, 4, 5, key='value')