Low priority documentation request.
I'm studying the documentation on how to write a C module.
http://docs.python.org/ext/node22.html
Please update the sample code in the documentation to
use "first_name" rather than "first" and "last_name"
rather than "last".
When I first studied the code and saw "first" and
"last" members in a structure, I thought those were for
a linked list of some sort. Much later in the code I
realized that the object was supposed to have a first
name and a last name, and there was no linked list at all.
"first_name" would be much more self-documenting than
"first". An acceptable alternative would be a comment
after the "first" declaration, saying: /* first name */
This is a small point, but I think it would be an
improvement to the documentation.
|