[libvirt] [PATCH] docs: remove "returns" word from beginning of lines

Eric Blake eblake at redhat.com
Fri Apr 8 22:31:38 UTC 2011


On 04/07/2011 02:47 AM, Jean-Baptiste Rouault wrote:
> Move "returns" keyword from beginning of API doc lines
> when it does not describe return values.

ACK, and pushed.

> Maybe the API doc extractor could be changed to look for
> "returns: " to avoid such confusion.

Probably, but I'm no python wizard, so I'm not writing that patch.
Anyone else want to help?

> - * If the callback wishes to keep the domain object after the callback
> - * returns, it shall take a reference to it, by calling virDomainRef.
> + * If the callback wishes to keep the domain object after the callback returns,
> + * it shall take a reference to it, by calling virDomainRef.

-- 
Eric Blake   eblake at redhat.com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 619 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20110408/3ce9bce7/attachment-0001.sig>


More information about the libvir-list mailing list