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

Re: [libvirt] [PATCH 1/5] docs: api_extension: Remove links to the stale example patches



On Thu, Aug 23, 2018 at 10:50:30AM +0200, Peter Krempa wrote:
> The pathches used as an example for the api_extension manual don't hold

s/pathches/patches

> up to the current standards any more. Carefully remove links and
> mentions of the patches from the docs.

While I understand the impetus for the change, I am personally not convinced
that we want to get rid of practical examples as a means of reference to the
text, it's like a product documentation without examples - "hardcore mode".
The fact that we took a patch series from the list archives as a reference
probably wasn't the best thing to do, I think we should instead come up with a
dummy API exercising all the sections in the docs which will conform to our
current standards and which we can update as we please. I know that's much more
work and effort which I can see you'd refuse to put into this, but I fear that
once you drop this, we won't update the docs with another examples for
years/ever and I'm not in favour of such practice.

Erik


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