F21 System Wide Change: Optional Javadocs

Stanislav Ochotnicky sochotnicky at redhat.com
Wed Mar 19 10:04:56 UTC 2014


On Tue 18 Mar 2014 07:03:31 PM CET Miloslav Trmač wrote:

> 2014-03-18 15:31 GMT+01:00 Jaroslav Reznik <jreznik at redhat.com>:
>> = Proposed System Wide Change: Optional Javadocs =
>> https://fedoraproject.org/wiki/Changes/OptionalJavadocs
>
> I suppose shipping API documentation for end-user applications really
> doesn't make sense.  Any reasonably-widely-used library should contain
> off-line documentation, if at all possible, IMHO.

Well as-of-this-moment-current guidelines actually mandate API
documentation even for end-user apps so there's room for improvement :-)

>> Release Notes
>> Javadoc subpackages have been made optional.
> "Made optional" is true from the packaging guidelines' point of view; for
> the users, some subpackages have simply been *removed*, and there's nothing
> optional about that.

You have a point, I'll rephrase that

--
Stanislav Ochotnicky <sochotnicky at redhat.com>
Software Engineer - Developer Experience

PGP: 7B087241
Red Hat Inc.                               http://cz.redhat.com
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 835 bytes
Desc: not available
URL: <http://lists.fedoraproject.org/pipermail/devel/attachments/20140319/7ebf4a04/attachment.sig>


More information about the devel mailing list