Re: Discouraging use of sync APIs

[Sébastien Wilmet <swilmet gnome org>]

On Fri, Feb 13, 2015 at 09:33:24AM +0000, Philip Withnall wrote:
>  3. Rearranging the docs to promote async functions more
>    ? Has not been discussed
>    - Big red warnings in the docs may just be ignored by people
>
> Anybody have any thoughts about option #3? I’m wary about filling the
> docs up with big red warnings.

Instead of a warning for each sync function, there could be a longer
explanation in the GFile class description:
https://developer.gnome.org/gio/stable/GFile.html#GFile.description

And/or in the GIO overview ("Writing GIO applications"):
https://developer.gnome.org/gio/stable/ch02.html

The latter could contain the longer explanation. And the former could
have a reminder with a link to the latter.


Sébastien