Examples in the documentation is not clear enough

Bug #663821 reported by Erkan Ozgur Yilmaz
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mocker
New
Undecided
Unassigned

Bug Description

For several reasons, the code examples in the documentation are cumbersome:
 - First of all, it doesn't show the import statement, which, I presume, is "from mocker import *", and this is something a good Python developer avoids all the time and makes the example unfamiliar for that particular developer.
 - Uses of the word "mocker" as a variable holding a mock object confuses the readers mind because the word "mocker" is also the name of the package and without seeing the import statement at the beginning of the code example that forces you to guess and remember that the whole package is imported to the module namespace.

description: updated
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.