From 470c3026ae1d3f9fed2f96467e47c74dcebc0e73 Mon Sep 17 00:00:00 2001 From: Yash-Garg Date: Sun, 13 Apr 2025 21:21:11 +0530 Subject: [PATCH] fix: add proper description for `User` class --- lib/src/user.dart | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/lib/src/user.dart b/lib/src/user.dart index 71ef5d0f..392d822d 100644 --- a/lib/src/user.dart +++ b/lib/src/user.dart @@ -18,7 +18,16 @@ import 'package:matrix/matrix.dart'; -/// Represents a Matrix User which may be a participant in a Matrix Room. +/// Represents a user in the context of a Matrix room, not a global user profile. +/// +/// This class extends [StrippedStateEvent] to handle room-specific user state, +/// including membership status, display name, and avatar within that room. +/// The user information is derived from room member state events. +/// +/// For example, a user may have different display names or avatars in different rooms, +/// and this class represents that room-specific view of the user rather than their +/// global profile. +/// class User extends StrippedStateEvent { final Room room; final Map? prevContent;