This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Corrections for the "extending" doc
Type: Stage: resolved
Components: Documentation Versions: Python 3.3
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: eli.bendersky Nosy List: docs@python, eli.bendersky, eric.araujo, ezio.melotti, georg.brandl, python-dev
Priority: low Keywords: easy, patch

Created on 2012-02-26 11:08 by eli.bendersky, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue_14129.1.patch eli.bendersky, 2012-02-27 14:02 review
Messages (15)
msg154325 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 11:08
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.
msg154326 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 11:09
extending.html has a reference to "Demo/embed/demo.c" which no longer exists in the source distribution
msg154341 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 13:09
"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.
msg154342 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 13:12
"in this case, nothing more than every Python object contains"

There's a grammar error lurking somewhere in there...
msg154344 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 13:26
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
msg154346 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 13:33
"Let’s expend "

Typo
msg154347 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 13:44
"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
msg154348 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 13:55
"but in this cased"

Typo

[this and the past couple of comments refer to the newtypes.html doc]
msg154349 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 13:58
Noddy_name in the full code listing (included from noddy2.c) is different from the Noddy_name that is actually explained later
msg154419 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-26 22:55
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.
msg154434 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-27 06:15
Adding the documentation experts. 

I plan to apply a fix for these soon. If you guys have any objections, let me know.
msg154441 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-02-27 08:56
> "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?
msg154480 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-27 14:02
Patch attached
msg154492 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-02-27 17:17
Thanks for the review. I'm going to do the commit now. Feel free to just fix it if any obvious mistakes remain.
msg154494 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-02-27 17:19
New changeset 6c737eb12c3e by Eli Bendersky in branch 'default':
Some corrections for the Doc/extending documentation. Closes #14129
http://hg.python.org/cpython/rev/6c737eb12c3e
History
Date User Action Args
2022-04-11 14:57:27adminsetgithub: 58337
2012-02-27 17:19:11python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg154494

resolution: fixed
stage: patch review -> resolved
2012-02-27 17:17:27eli.benderskysetmessages: + msg154492
2012-02-27 14:02:51eli.benderskysetfiles: + issue_14129.1.patch
keywords: + patch
messages: + msg154480

stage: patch review
2012-02-27 08:56:11eric.araujosetmessages: + msg154441
2012-02-27 06:15:05eli.benderskysetnosy: + georg.brandl, ezio.melotti, eric.araujo
messages: + msg154434
2012-02-26 22:55:09eli.benderskysetmessages: + msg154419
2012-02-26 13:58:45eli.benderskysetmessages: + msg154349
2012-02-26 13:55:01eli.benderskysetmessages: + msg154348
2012-02-26 13:44:28eli.benderskysetmessages: + msg154347
2012-02-26 13:33:45eli.benderskysetmessages: + msg154346
2012-02-26 13:26:30eli.benderskysetmessages: + msg154344
2012-02-26 13:12:14eli.benderskysetmessages: + msg154342
2012-02-26 13:09:11eli.benderskysetnosy: + docs@python
messages: + msg154341
2012-02-26 11:09:31eli.benderskysetmessages: + msg154326
2012-02-26 11:08:57eli.benderskycreate