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
This commit is contained in:
Philip Withnall 2021-06-16 11:14:03 +01:00
parent 00feb4d5a9
commit 9c7caf540e

View File

@ -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