From c41f1b42dfb7406a464cba052d12c4def1fb4663 Mon Sep 17 00:00:00 2001 From: "B. Petersen" Date: Tue, 9 Feb 2021 16:35:11 +0100 Subject: [PATCH] update docs for dc_contact_get_name() --- deltachat-ffi/deltachat.h | 6 ++++-- src/contact.rs | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/deltachat-ffi/deltachat.h b/deltachat-ffi/deltachat.h index 56a3fe920..ec9434264 100644 --- a/deltachat-ffi/deltachat.h +++ b/deltachat-ffi/deltachat.h @@ -4015,8 +4015,10 @@ char* dc_contact_get_addr (const dc_contact_t* contact); /** - * Get the contact name. This is the name as defined by the contact himself or - * modified by the user. May be an empty string. + * Get the edited contact name. + * This is the name as given or modified by the local user using dc_create_contact(). + * If there is no such name for the contact, an empty string is returned. + * The function does not return the contact name as received from the network. * * This name is typically used in a form where the user can edit the name of a contact. * To get a fine name to display in lists etc., use dc_contact_get_display_name() or dc_contact_get_name_n_addr(). diff --git a/src/contact.rs b/src/contact.rs index c51567424..6137335e1 100644 --- a/src/contact.rs +++ b/src/contact.rs @@ -867,8 +867,8 @@ impl Contact { &self.authname } - /// Get the contact name. This is the name as defined by the contact himself or - /// modified by the user. May be an empty string. + /// Get the contact name. This is the name as modified by the local user. + /// May be an empty string. /// /// This name is typically used in a form where the user can edit the name of a contact. /// To get a fine name to display in lists etc., use `Contact::get_display_name` or `Contact::get_name_n_addr`.