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

Daniel Veillard veillard at redhat.com
Mon Apr 11 02:16:55 UTC 2011


On Fri, Apr 08, 2011 at 04:31:38PM -0600, Eric Blake wrote:
> 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?

  I looked at it upon receiving the patch, it's trivial from a python
puoint of view, the problem is that we then need to change all function
descriptions to use "Returns:" instead of "Returns" and I'm not sure
it's really teh right thing to do,

Daniel

-- 
Daniel Veillard      | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
daniel at veillard.com  | Rpmfind RPM search engine http://rpmfind.net/
http://veillard.com/ | virtualization library  http://libvirt.org/




More information about the libvir-list mailing list