Corrections for the "extending" doc

[elibendersky]

BPO	14129
Nosy	@birkenfeld, @ezio-melotti, @merwok
Files	issue_14129.1.patch

^{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 = <Date 2012-02-27.17:19:11.514>
created_at = <Date 2012-02-26.11:08:57.945>
labels = ['easy', 'docs']
title = 'Corrections for the "extending" doc'
updated_at = <Date 2012-02-27.17:19:11.512>
user = 'https://bugs.python.org/elibendersky'

bugs.python.org fields:

activity = <Date 2012-02-27.17:19:11.512>
actor = 'python-dev'
assignee = 'eli.bendersky'
closed = True
closed_date = <Date 2012-02-27.17:19:11.514>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2012-02-26.11:08:57.945>
creator = 'eli.bendersky'
dependencies = []
files = ['24663']
hgrepos = []
issue_num = 14129
keywords = ['patch', 'easy']
message_count = 15.0
messages = ['154325', '154326', '154341', '154342', '154344', '154346', '154347', '154348', '154349', '154419', '154434', '154441', '154480', '154492', '154494']
nosy_count = 6.0
nosy_names = ['georg.brandl', 'ezio.melotti', 'eric.araujo', 'eli.bendersky', 'docs@python', 'python-dev']
pr_nums = []
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue14129'
versions = ['Python 3.3']

[elibendersky]

I'm now carefully reading through the "extending" documentation pages. This issue will record various problems I find on the way, with the intention of fixing them eventually.

[elibendersky]

extending.html has a reference to "Demo/embed/demo.c" which no longer exists in the source distribution

[elibendersky]

"A PyObject is not a very magnificent object - it just contains the refcount and a pointer to the object’s “type object”."

Too chatty and should be replaced by a more pragmatic explanation, or shortened.

[elibendersky]

"in this case, nothing more than every Python object contains"

There's a grammar error lurking somewhere in there...

[elibendersky]

This is not strictly in the extending doc, but linked from it:

http://docs.python.org/dev/c-api/type.html#PyType_GenericNew

The PyType_GenericNew API function is not documented

[elibendersky]

"Let’s expend "

Typo

[elibendersky]

"The new method calls the tp_alloc slot to allocate memory"

tp_alloc needs formatting here, similarly to the way it's done in other places

[elibendersky]

"but in this cased"

Typo

[this and the past couple of comments refer to the newtypes.html doc]

[elibendersky]

Noddy_name in the full code listing (included from noddy2.c) is different from the Noddy_name that is actually explained later

[elibendersky]

There are some:

"
XXX Need to ...
"

Paragraphs scattered across the doc. These have no place in the official documentation. For placeholders, an issue can be created that lists all the things that need to be done.

[elibendersky]

Adding the documentation experts.

I plan to apply a fix for these soon. If you guys have any objections, let me know.

[merwok]

"in this case, nothing more than every Python object contains"
There's a grammar error lurking somewhere in there...

It could be: “nothing more that what every Python object contains”.

Could you post a patch for review?

[elibendersky]

Patch attached

[elibendersky]

Thanks for the review. I'm going to do the commit now. Feel free to just fix it if any obvious mistakes remain.

[python-dev]

New changeset 6c737eb12c3e by Eli Bendersky in branch 'default':
Some corrections for the Doc/extending documentation. Closes bpo-14129
http://hg.python.org/cpython/rev/6c737eb12c3e