Write user's version of the reference guide

[akuchling]

BPO	1376292
Nosy	@akuchling
Dependencies	bpo-966625: Documentation for Descriptors in the main docs

^{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 = 'https://github.com/akuchling'
closed_at = <Date 2010-11-12.20:49:55.783>
created_at = <Date 2005-12-08.13:55:37.000>
labels = ['type-feature', 'docs']
title = "Write user's version of the reference guide"
updated_at = <Date 2010-11-12.20:49:55.782>
user = 'https://github.com/akuchling'

bugs.python.org fields:

activity = <Date 2010-11-12.20:49:55.782>
actor = 'akuchling'
assignee = 'akuchling'
closed = True
closed_date = <Date 2010-11-12.20:49:55.783>
closer = 'akuchling'
components = ['Documentation']
creation = <Date 2005-12-08.13:55:37.000>
creator = 'akuchling'
dependencies = ['966625']
files = []
hgrepos = []
issue_num = 1376292
keywords = []
message_count = 3.0
messages = ['61214', '65757', '121075']
nosy_count = 2.0
nosy_names = ['akuchling', 'bgailer']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue1376292'
versions = ['Python 3.2']

[akuchling]

The Reference Guide is very detailed and difficult to
read, but nothing else documents things like statements
or special object methods.

We should have a shorter, friendlier guide to the
syntax and basic types.

[bgailer]

I find a Reference Manual and a Library Reference. I presume you are
referring to the Reference Manual. True?

I might be interested in helping create the shorter friendlier guide. I
suggest we create some guidelines or specifications for it. This might
be a task for several of us, each taking a section, or some other form
of collaboration.

[akuchling]

Not likely to be worked on, and whether to write such a guide is a question for the docs editor (or the Doc-SIG).