[grilo/wip/hadess/throttling-docs] net: Document changed "throttling" property behaviour

[Bastien Nocera <hadess src gnome org>]

commit 7fc7f1b94b264961b981a0893318013296a0cb02
Author: Bastien Nocera <hadess hadess net>
Date:   Wed Jul 6 17:39:03 2022 +0200

    net: Document changed "throttling" property behaviour
    
    We needed to change the runtime behaviour when compiled against libsoup3
    to avoid an API/ABI change.

 libs/net/grl-net-wc.c | 8 ++++++++
 1 file changed, 8 insertions(+)
---
diff --git a/libs/net/grl-net-wc.c b/libs/net/grl-net-wc.c
index 20de7a9..d49351d 100644
--- a/libs/net/grl-net-wc.c
+++ b/libs/net/grl-net-wc.c
@@ -129,6 +129,10 @@ grl_net_wc_class_init (GrlNetWcClass *klass)
    *
    * The timeout in seconds between connections. All the connections will be
    * queued and each one will be dispatched after waiting this value.
+   *
+   * Note that if the grl-net library was compiled against libsoup3, changing
+   * the throttling configuration will show a warning if done after the first
+   * request.
    */
   g_object_class_install_property (g_klass,
                                    PROP_THROTTLING,
@@ -1099,6 +1103,10 @@ grl_net_wc_set_log_level (GrlNetWc *self,
  *
  * Setting this property, the #GrlNetWc will queue all the requests and
  * will dispatch them with a pause between them of this value.
+ *
+ * Note that if the grl-net library was compiled against libsoup3, changing
+ * the throttling configuration will show a warning if done after the first
+ * request.
  */
 void
 grl_net_wc_set_throttling (GrlNetWc *self,