[Bf-python] Error in mathutils docs

[Gilbert, Joseph T.]

Bad wording in the docs on my part. By "copy" I meant a reference not a
new object. As ken mentioned they were always meant to return a pointer
to self, so to speak, so that they could be chained using methods.
method1().method2().method3()

-----Original Message-----
From: bf-python-bounces at projects.blender.org
[mailto:bf-python-bounces at projects.blender.org] On Behalf Of Joe Eagar
Sent: Sunday, July 09, 2006 2:11 PM
To: Blender Foundation Python list
Subject: Re: [Bf-python] Error in mathutils docs

Ken Hughes wrote:
> Joe Eagar wrote:
>> Hi.  In the cvs epydocs, the Mathutils.Vector page says that the 
>> Vector methods return a copy of the source vector.  After looking at 
>> the code in vector.c, this is clearly not the case; the functions 
>> simply return the original vector.
>
> Don't think anyone answered this, and Joseph would be the best to 
> explain, but IIRC this is true but perhaps misleading.  Perhaps it 
> should say returns a new reference to the object.  This was for users 
> who wanted to concatenate operations, such as
There's a big difference between a new *reference* and a full copy. :)  
Why not just say "Returns: itself" or "Returns: reference to itself"?  
"Returns: A copy of itself" it not misleading, it's wrong.

Joe
_______________________________________________
Bf-python mailing list
Bf-python at projects.blender.org
http://projects.blender.org/mailman/listinfo/bf-python