policy suggestion: API docs are not for users
Hi,
I've just noticed that the user documentation package for ant (a tool,
not a library) contains 15 MB of API references. I've since filed bug
#174876 asking for this to be removed.
I think it might be useful for a comment to be added to section 2.3 of
policy - Java Programs. perhaps something like:
Program documentation packages should be treated in exactly the same way
as they would for non-Java programs. They should contain information
which the users may want: manuals, example settings files, etc. This
should not include source code or developer documentation, such as that
automatically generated from source code.
If anyone has legitimate reasons for including API docs in a -doc
package (for a program, not a library), then I would love to know what
they are.
--
.''`. Mark Howard
: :' :
`. `' http://www.tildemh.com
`- mh@debian.org | mh@tildemh.com | mh344@cam.ac.uk
Reply to: