Home Original page

[Python-Dev] cpython: Adding unittest.mock documentation

Georg Brandl g.brandl at gmx.net
Mon Mar 26 09:11:50 CEST 2012 
On 26.03.2012 00:13, michael.foord wrote:
> http://hg.python.org/cpython/rev/adc1fc2dc872
> changeset:   75938:adc1fc2dc872
> user:        Michael Foord <michael at voidspace.org.uk>
> date:        Sun Mar 25 23:12:55 2012 +0100
> summary:
>   Adding unittest.mock documentation
> 
> files:
>   Doc/library/development.rst                   |    6 +
>   Doc/library/unittest.mock-examples.rst        |  887 +++++++++
>   Doc/library/unittest.mock-getting-started.rst |  419 ++++
>   Doc/library/unittest.mock-helpers.rst         |  537 +++++
>   Doc/library/unittest.mock-magicmethods.rst    |  226 ++
>   Doc/library/unittest.mock-patch.rst           |  538 +++++
>   Doc/library/unittest.mock.rst                 |  900 ++++++++++
>   Lib/unittest/mock.py                          |    8 +-
>   8 files changed, 3516 insertions(+), 5 deletions(-)

That seems a bit much splitting to me.

(By the way, the ".. module::" directive should only be in *one* place.)

I would organize the mock, mock-patch, mock-magicmethods and mock-helpers as one
file in Doc/library, and put the other two in Doc/howto, just as for logging.

In general, I wouldn't mind splitting off more of the exemplary material from
the main library docs, putting it in the howto section.

Georg
More information about the Python-Dev mailing list