[glib: 1/2] gsettingsschema: Fix docs for g_settings_schema_key_range_check()
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib: 1/2] gsettingsschema: Fix docs for g_settings_schema_key_range_check()
- Date: Tue, 7 Sep 2021 10:59:10 +0000 (UTC)
commit 9c7caf540ed47e8573c73538daf9449d864c746b
Author: Philip Withnall <pwithnall endlessos org>
Date: Wed Jun 16 11:14:03 2021 +0100
gsettingsschema: Fix docs for g_settings_schema_key_range_check()
The first sentence incorrectly said that it checked the type of the
value, and then the second sentence explicitly said it was a programmer
error to give a value of the wrong type.
According to the code, the second sentence is correct.
Signed-off-by: Philip Withnall <pwithnall endlessos org>
Fixes: #2425
gio/gsettingsschema.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/gio/gsettingsschema.c b/gio/gsettingsschema.c
index ec0caf655..3b5ba0d56 100644
--- a/gio/gsettingsschema.c
+++ b/gio/gsettingsschema.c
@@ -1857,10 +1857,10 @@ g_settings_schema_key_get_range (GSettingsSchemaKey *key)
* @key: a #GSettingsSchemaKey
* @value: the value to check
*
- * Checks if the given @value is of the correct type and within the
+ * Checks if the given @value is within the
* permitted range for @key.
*
- * It is a programmer error if @value is not of the correct type -- you
+ * It is a programmer error if @value is not of the correct type — you
* must check for this first.
*
* Returns: %TRUE if @value is valid for @key
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]