[pacman-dev] [PATCH] Add documentation for transaction events

[Sebastian Nowicki]

On 27/04/2008, at 5:03 PM, Xavier wrote:
> Sebastian Nowicki wrote:
>> +
>> +	/** Package waas extracted
>> +	 *
>> +	 * No parameters are passed
>> +	 */
>> 	PM_TRANS_EVT_EXTRACT_DONE,
>
> s/waas/was
>
>> +
>> +	/** Target deltas's integrity will be checked
>> +	 *
>> +	 * No parameters are passed
>> +	 */
>> 	PM_TRANS_EVT_DELTA_INTEGRITY_START,
>
> Shouldn't it be deltas' or something? Not even sure :)

Yes, deltas', damn typos :P

>
> Except these two typos, it looks alright. I just had the same first
> impression as Dan, it looks a bit intrusive. Though you already  
> removed
> one line from the original patch, but too bad we can't remove more.
>
> I was thinking, do we really need to specify "No parameters are  
> passed"
> every time? Maybe having no description could implicitly means that no
> parameters are passed.

For documentation I think explicit is better than implicit. Someone  
could assume that it's simply not documented. Though I was thinking,  
maybe "NULL parameters are passed" or something would be better. We  
could just say "NULL parameters are passed unless specified otherwise"  
in the documentation of the enum itself. Although the enum's brief  
doesn't seem to show up anywhere...

--
Sebastian Nowicki