fix incorrect documentation

JFreegman · JFreegman · commit 8ed47f3ef2c7 · 2023-08-16T23:41:08.000-04:00
The key used to get wiped on a kick but this is
no longer the case
diff --git a/toxcore/tox.h b/toxcore/tox.h
@@ -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.
  *
- * This key will be permanently tied to a particular peer until they explicitly leave the group or
- * get kicked, and is the only way to reliably identify the same peer across client restarts.
+ * This key will be permanently tied to a particular peer until they explicitly leave the group and is
+ * 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
  * this function has no effect.

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