pidgin/pidgin

Update purple_contact_sort's documentation to say it returns < 0 and > 1

18 months ago, Gary Kramlich
0472e404b129
Parents 7509b313b098
Children f35eb5adb2e0
Update purple_contact_sort's documentation to say it returns < 0 and > 1

It turns out that g_utf8_collate will return values other than -1, 0, and 1 on
BSD which broke the unit tests which were expecting -1 but got -25.

Testing Done:
Ran the unit tests on FreeBSD and verified they passed.

Reviewed at https://reviews.imfreedom.org/r/2077/
2 files changed, 8 insertions(+), 8 deletions(-)
  • +2 -2
    libpurple/purplecontact.h
  • +6 -6
    libpurple/tests/test_contact.c
    • --- a/libpurple/purplecontact.h Sat Nov 19 04:38:48 2022 -0600
    +++ b/libpurple/purplecontact.h Sat Nov 19 16:49:14 2022 -0600
    @@ -328,8 +328,8 @@
    *
    * Compares contacts @a and @b
    *
    - * Returns: -1 if @a should be sorted before @b, 0 if they sorted equally, and
    - * 1 if @a should be sorted after @b.
    + * Returns: less than 0 if @a should be sorted before @b, 0 if they sorted
    + * equally, and greater than 0 if @a should be sorted after @b.
    *
    * Since: 3.0.0
    */
    --- a/libpurple/tests/test_contact.c Sat Nov 19 04:38:48 2022 -0600
    +++ b/libpurple/tests/test_contact.c Sat Nov 19 16:49:14 2022 -0600
    @@ -246,7 +246,7 @@
    account = purple_account_new("test", "test");
    contact = purple_contact_new(account, NULL);
    - g_assert_cmpint(purple_contact_compare(contact, NULL), ==, -1);
    + g_assert_cmpint(purple_contact_compare(contact, NULL), <, 0);
    g_clear_object(&account);
    g_clear_object(&contact);
    @@ -260,7 +260,7 @@
    account = purple_account_new("test", "test");
    contact = purple_contact_new(account, NULL);
    - g_assert_cmpint(purple_contact_compare(NULL, contact), ==, 1);
    + g_assert_cmpint(purple_contact_compare(NULL, contact), >, 0);
    g_clear_object(&account);
    g_clear_object(&contact);
    @@ -286,7 +286,7 @@
    contact_b = purple_contact_new(account, NULL);
    - g_assert_cmpint(purple_contact_compare(contact_a, contact_b), ==, -1);
    + g_assert_cmpint(purple_contact_compare(contact_a, contact_b), <, 0);
    g_clear_object(&account);
    g_clear_object(&contact_a);
    @@ -309,7 +309,7 @@
    person = purple_person_new();
    purple_contact_set_person(contact_b, person);
    - g_assert_cmpint(purple_contact_compare(contact_a, contact_b), ==, 1);
    + g_assert_cmpint(purple_contact_compare(contact_a, contact_b), >, 0);
    g_clear_object(&account);
    g_clear_object(&contact_a);
    @@ -331,8 +331,8 @@
    contact_b = purple_contact_new(account, NULL);
    purple_contact_set_username(contact_b, "zzz");
    - g_assert_cmpint(purple_contact_compare(contact_a, contact_b), ==, -1);
    - g_assert_cmpint(purple_contact_compare(contact_b, contact_a), ==, 1);
    + g_assert_cmpint(purple_contact_compare(contact_a, contact_b), <, 0);
    + g_assert_cmpint(purple_contact_compare(contact_b, contact_a), >, 0);
    purple_contact_set_username(contact_b, "aaa");
    g_assert_cmpint(purple_contact_compare(contact_b, contact_a), ==, 0);