emoji [nfc]: Dartdoc EmojiStore.emojiDisplayFor

Author: chrisbobbe

lib/model/emoji.dart

@@ -116,6 +116,14 @@ final class EmojiCandidate {
 
 /// The portion of [PerAccountStore] describing what emoji exist.
 mixin EmojiStore {
+  /// An [EmojiDisplay] for the specified emoji.
+  ///
+  /// Use [EmojiDisplay.resolve] on the result to apply the user's [Emojiset]
+  /// setting.
+  ///
+  /// May be a [TextEmojiDisplay] even if the emojiset is not [Emojiset.text];
+  /// this happens when we can't understand the data that describes the emoji
+  /// (e.g. when an image emoji's URL doesn't parse)..
   EmojiDisplay emojiDisplayFor({
     required ReactionType emojiType,
     required String emojiCode,