[New-bugs-announce] [issue12672] Some problems in documentation extending/newtypes.html

Eli Bendersky report at bugs.python.org
Mon Aug 1 05:54:54 CEST 2011


New submission from Eli Bendersky <eliben at gmail.com>:

Reading the C API documentation: extending/newtypes.html

Some problems:

1. In the first paragraph of 2.1 - "to distinguish them from things like [].append", it's unclear what [].append is. Maybe "[] and append"?
2. The C coding convention is unusual and non PEP-7 in 2.1.1 (after "if (self->first == NULL)" in Noddy_new)
3. The previous problem repeats in other instances of Noddy_new in the document


I found these while reading the 2.7 docs, but they could also exist in 3.x (didn't check).

----------
assignee: docs at python
components: Documentation
keywords: easy
messages: 141487
nosy: docs at python, eli.bendersky
priority: low
severity: normal
status: open
title: Some problems in documentation extending/newtypes.html
versions: Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12672>
_______________________________________


More information about the New-bugs-announce mailing list