Re: bzr commit into mysql-5.1 branch (martin.hansson:3587) Bug#59839

[Martin Hansson]

Jorgen Loland wrote:
> Hi Martin,
>
> What a cute little patch ;) Code approved, but see comment re. 
> documentation
>
> On 02/09/2011 10:58 AM, Martin Hansson wrote:
>>
>> +  @return Status
>> +  @retval true An error occured.
>> +  @retval false OK.
>> +
>> +  @todo This comment must be restructured. It is jumping back and forth
>> +        between abstraction levels and it uses inconsistent 
>> terminology.
>> + */
>
> You've modified almost the entire documentation for this function. Why 
> don't you go ahead an restructure it now that you have the code fresh 
> in mind. Noone else is going to do it ;)
>
Actually it isn't restructured that much. I noticed the documentation 
had changed between 5.1 and 5.5 so I just bashed in the 5.5 
documentation and only did minor brushing up. Diff it with 5.5 and 
you'll see. :-)


Best Regards

Martin