[ python-Bugs-1021621 ] use first_name, not first, in code samples

[SourceForge.net]

Bugs item #1021621, was opened at 2004-09-03 06:27
Message generated for change (Comment added) made by mwh
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1021621&group_id=5470

Category: Documentation
Group: Feature Request
Status: Open
Resolution: None
Priority: 1
Submitted By: Steve R. Hastings (steveha)
Assigned to: Nobody/Anonymous (nobody)
Summary: use first_name, not first, in code samples

Initial Comment:
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.

----------------------------------------------------------------------

>Comment By: Michael Hudson (mwh)
Date: 2004-09-03 11:59

Message:
Logged In: YES 
user_id=6656

FWIW, I agree.  I'm attempting to rewrite the extending and 
embedding manual, and yes, this is one of the things I've changed.

I've just uploaded my latest draft to

   http://starship.python.net/crew/mwh/toext/

which gets a little way into the area of defining new types.  I'd 
really appreciate your comments! (to mwh at python.net, please).

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1021621&group_id=5470