On Mon, 2015-02-02 at 17:11 +0100, Sébastien Wilmet wrote:
> On Mon, Feb 02, 2015 at 04:51:32PM +0100, Aleksander Morgado wrote:
> > Devhelp could also have a 'next' or 'latest' default profile which could
> > sync the daily? built documentation from gnome.org. Although not sure
> > how useful this could be if we setup the default jhbuild-based profile.
> > 
> > I personally think that the profiles idea could be a good one, also as a
> > first step for the next stuff. What do others think?
> 
> Having only the 'latest' profile should be sufficient for most
> developers, for each major version of a library of course (e.g. the
> latest gtk 2.x and the latest gtk 3.x). Each symbol has the "Since:
> <version>" information anyway. And by having the latest documentations,
> developers are aware of new features and don't reinvent the wheel or
> don't use APIs that are already deprecated since a later version.
> 
> But 'latest' should have two variants: stable and unstable.
> 
> Of course, having other profiles for specific versions of GNOME would be
> nice, but the 'latest' profiles should be the default and recommended in
> my opinion.

I believe there are various APIs where the ‘Since’ annotations have not
been, and are not, added correctly. I suspect we will have to aim for
having profiles for each minor release of each library — but that should
not be any more complex than supporting latest stable and latest
unstable profiles, which I think is a great idea.

One question: does ‘latest unstable’ mean git master, or the latest
release in the unstable branch? There are plenty of times I’ve needed
documentation for unreleased functions newly added in git master; I
can’t think of any time I’ve needed documentation for the latest
unstable release instead.

Philip

Attachment: signature.asc
Description: This is a digitally signed message part

_______________________________________________
desktop-devel-list mailing list
desktop-devel-list@gnome.org
https://mail.gnome.org/mailman/listinfo/desktop-devel-list

Reply via email to