From fec3fd6b1369455094a93725a7c9bcce290c0260 Mon Sep 17 00:00:00 2001 From: Michael Foord Date: Fri, 27 Jan 2012 01:03:53 +0000 Subject: Minor doc updates --- docs/getting-started.txt | 6 ++++-- 1 file 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') -- cgit v1.2.1