Re: [PATCH] apibuild: Disallow 'returns' return decription

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



s/decription/description/ in the commit message

On 05/12/2014 02:29 PM, Michal Privoznik wrote:
> Our documentation generator is a bit messy, to say the least. For
> instance, the description to return values of a function is searched
> within C comment. Currently, all lines that start with 'returns' or
> 'Returns' are viewed as return value description. However, there are
> some valid uses where the 'returns' word is in the middle of a
> sentence describing function behavior nor the return value. For

s/nor/not/

And there are no places where 'returns' is used to describe return values.

> instance: virDomainDetachDeviceFlags,
> virConnectNetworkEventRegisterAny and virDomainGetDiskErrors. This
> leads to HTML documentation to be not correctly generated.

"to be not" doesn't sound right to me. How about:
leads to HTML documemtation being generated incorrectly

> 
> Signed-off-by: Michal Privoznik <mprivozn@xxxxxxxxxx>
> ---
>  docs/apibuild.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

ACK

Jan

Attachment: signature.asc
Description: OpenPGP digital signature

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list

[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]