On Tue, Apr 24, 2007 at 09:13:18AM +0200, Stefano Zacchiroli wrote: > On Mon, Apr 23, 2007 at 04:27:34PM -0700, Steve Langasek wrote: > > > > On 23-Apr-07, 15:51 (CDT), Neil Williams <[EMAIL PROTECTED]> wrote: > > > > > I think that all libraries - without exception - must come with some > > > > > API documentation and the docs should be as complete and as accurate > > > > > as possible - ideally generated from the source itself. > > That the existing requirement is already too much for us to keep up with, so > > adding new requirements, especially ones that require significant attention > > to detail to get right, dilutes our attention for little benefit?
> If we are talking about hand-written documentation you're of course > right. However if you're talking about documentation which can be > generated automatically from sources (and not that it was the "ideal" > point of Neil) than you're not. There are ways to generate manpages from --help output of programs. We still have a lot of programs in Debian with no manpages. > It happened to me many times to find library -dev packages with upstream > sources commented with some literate programming stuff but nevertheless > missing the corresponding automatically generated API docs in the > package. That's a pity. And that's something the policy should address. Hmm, I don't agree that it needs to be addressed in policy, FWIW. -- Steve Langasek Give me a lever long enough and a Free OS Debian Developer to set it on, and I can move the world. [EMAIL PROTECTED] http://www.debian.org/ -- To UNSUBSCRIBE, email to [EMAIL PROTECTED] with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]
