Skip to content

Commit a89ce8c

Browse files
committed
docs: update documentation for TransportsModified event
It is a follow-up to #7643 Event is not emitted when the transports are modified on this device and we should consistently say that this event is not only for testing.
1 parent 9ac64ea commit a89ce8c

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

deltachat-ffi/deltachat.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6706,8 +6706,8 @@ void dc_event_unref(dc_event_t* event);
67066706
* Transport relay added/deleted or default has changed.
67076707
* UI should update the list.
67086708
*
6709-
* The event is emitted when the transports are modified on this or on another device
6710-
* using the jsonrpc calls `add_or_update_transport`, `add_transport_from_qr`, `delete_transport`
6709+
* The event is emitted when the transports are modified on another device
6710+
* using the JSON-RPC calls `add_or_update_transport`, `add_transport_from_qr`, `delete_transport`
67116711
* or `set_config(configured_addr)`.
67126712
*/
67136713
#define DC_EVENT_TRANSPORTS_MODIFIED 2600

deltachat-jsonrpc/src/api/types/events.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -463,11 +463,11 @@ pub enum EventType {
463463

464464
/// One or more transports has changed.
465465
///
466-
/// This event is used for tests to detect when transport
467-
/// synchronization messages arrives.
468-
/// UIs don't need to use it, it is unlikely
469-
/// that user modifies transports on multiple
470-
/// devices simultaneously.
466+
/// UI should update the list.
467+
///
468+
/// This event is emitted when transport
469+
/// synchronization messages arrives,
470+
/// but not when the UI modifies the transport list by itself.
471471
TransportsModified,
472472
}
473473

src/events/payload.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -419,11 +419,11 @@ pub enum EventType {
419419

420420
/// One or more transports has changed.
421421
///
422-
/// This event is used for tests to detect when transport
423-
/// synchronization messages arrives.
424-
/// UIs don't need to use it, it is unlikely
425-
/// that user modifies transports on multiple
426-
/// devices simultaneously.
422+
/// UI should update the list.
423+
///
424+
/// This event is emitted when transport
425+
/// synchronization messages arrives,
426+
/// but not when the UI modifies the transport list by itself.
427427
TransportsModified,
428428

429429
/// Event for using in tests, e.g. as a fence between normally generated events.

0 commit comments

Comments
 (0)