Improve the docs. (#436293, Vincent Untz)

2007-11-08  Matthias Clasen <mclasen@redhat.com>

        * glib/goption.c (g_option_context_new): Improve the docs.
        (#436293, Vincent Untz)

svn path=/trunk/; revision=5834

diff --git a/ChangeLog b/ChangeLog
index 64cb8869e4c26a0f190cba9342cc3b9928db1205..71e31e9e02e37319b2638a6c491339ff87ba2725 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-11-08  Matthias Clasen <mclasen@redhat.com>
+
+       * glib/goption.c (g_option_context_new): Improve the docs.
+       (#436293, Vincent Untz)
+
 2007-11-08  Matthias Clasen <mclasen@redhat.com>
 
        * glib/gmain.c (g_main_loop_quit): Expand the docs 

diff --git a/glib/goption.c b/glib/goption.c
index c385140f091aeceb968bbdd7a1285732daa6c693..c1e6068a2e3aa3788f1485f8085b8c0b0dd3cfcd 100644 (file)
--- a/glib/goption.c
+++ b/glib/goption.c
@@ -205,8 +205,9 @@ g_option_error_quark (void)
  * program functionality that should be displayed as a paragraph
  * below the usage line, use g_option_context_set_summary().
  *
- * Note that the @parameter_string is translated (see
- * g_option_context_set_translate_func()). 
+ * Note that the @parameter_string is translated using the
+ * function set with g_option_context_set_translate_func(), so
+ * it should normally be passed untranslated.
  *
  * Returns: a newly created #GOptionContext, which must be
  *    freed with g_option_context_free() after use.