GNOME Bugzilla – Bug 756251
The documentation of G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is confusing
Last modified: 2015-10-09 12:17:16 UTC
The inconsistent use of negations makes it hard to read, and it isn't clear how it is different from G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION.
Created attachment 312916 [details] [review] docs: Improve the text on G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START Thanks to Jasper and Alex for clearing it up for me.
Comment on attachment 312916 [details] [review] docs: Improve the text on G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START >- * @G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START: If not set and the proxy if for a well-known name, >- * then request the bus to launch an owner for the name if no-one owns the name. This flag can >- * only be used in proxies for well-known names. >+ * @G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START: If the proxy is for a well-known name, >+ * do not ask the bus to launch an owner during proxy initialization or a method call. >+ * This flag can only be used in proxies for well-known names. "can only be used" isn't right. It's just that it has no effect otherwise. The DO_NOT_AUTO_START_AT_CONSTRUCTION docs phrase it as "This flag is only meaningful in proxies for well-known names", which seems like better wording. other than that, looks good
Created attachment 312943 [details] [review] docs: Improve the text on G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START
Comment on attachment 312943 [details] [review] docs: Improve the text on G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START Thanks, Dan. Pushed to master and glib-2-46.