Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize unittest.mock docs into linear manner #66540

Open
py-user mannequin opened this issue Sep 5, 2014 · 1 comment
Open

Reorganize unittest.mock docs into linear manner #66540

py-user mannequin opened this issue Sep 5, 2014 · 1 comment
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@py-user
Copy link
Mannequin

py-user mannequin commented Sep 5, 2014

BPO 22344
Nosy @rbtcollins, @ezio-melotti, @voidspace, @py-user

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2014-09-05.21:02:07.134>
labels = ['type-feature', 'docs']
title = 'Reorganize unittest.mock docs into linear manner'
updated_at = <Date 2014-11-02.18:09:45.183>
user = 'https://github.com/py-user'

bugs.python.org fields:

activity = <Date 2014-11-02.18:09:45.183>
actor = 'pitrou'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2014-09-05.21:02:07.134>
creator = 'py.user'
dependencies = []
files = []
hgrepos = []
issue_num = 22344
keywords = []
message_count = 1.0
messages = ['226456']
nosy_count = 5.0
nosy_names = ['rbcollins', 'ezio.melotti', 'michael.foord', 'docs@python', 'py.user']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue22344'
versions = ['Python 3.4', 'Python 3.5']

@py-user
Copy link
Mannequin Author

py-user mannequin commented Sep 5, 2014

Now, it's very inconvenient to learn this documentation. It's not compact (could be reduced in 2 or even 3 times). It repeats itself: many examples copy-pasted unchangeably. And it cites to terms that placed under those cites, so people should start at the bottom to anderstand what it's talking about on the top.

Remember Zen "If the implementation is hard to explain, it's a bad idea."

  • Move the MagicMock description to the point between Mock and PropertyMock descriptions
  • Remove "copy-paste" examples
  • Rename print to print() and StringIO to io
  • Split the Autospecing section to several chunks

@py-user py-user mannequin assigned docspython Sep 5, 2014
@py-user py-user mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Sep 5, 2014
@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement
Projects
Status: No status
Development

No branches or pull requests

0 participants