fix incorrect documentation

The key used to get wiped on a kick but this is
no longer the case
This commit is contained in:
jfreegman 2023-04-05 11:00:24 -04:00
parent a1e2458412
commit 8ed47f3ef2
No known key found for this signature in database
GPG Key ID: 3627F3144076AE63

View File

@ -3979,8 +3979,8 @@ Tox_Connection tox_group_peer_get_connection_status(const Tox *tox, uint32_t gro
/** /**
* Write the group public key with the designated peer_id for the designated group number to public_key. * Write the group public key with the designated peer_id for the designated group number to public_key.
* *
* This key will be permanently tied to a particular peer until they explicitly leave the group or * This key will be permanently tied to a particular peer until they explicitly leave the group and is
* get kicked, and is the only way to reliably identify the same peer across client restarts. * the only way to reliably identify the same peer across client restarts.
* *
* `public_key` should have room for at least TOX_GROUP_PEER_PUBLIC_KEY_SIZE bytes. If `public_key` is null * `public_key` should have room for at least TOX_GROUP_PEER_PUBLIC_KEY_SIZE bytes. If `public_key` is null
* this function has no effect. * this function has no effect.