refactor: improve jumpToMessage docstring

deltachat · Oct 12, 2024 · e040f79 · e040f79
1 parent 50c5b9b
commit e040f79
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/frontend/src/stores/messagelist.ts b/packages/frontend/src/stores/messagelist.ts
@@ -398,6 +398,8 @@ class MessageListStore extends Store<MessageListState> {
      * It can handle showing the message in a chat other than `this.chatId`,
      * loading the message if it is missing from `this.state.messageCache`,
      * and reloading `messageListItems` if the message is missing from there.
+     * @param msgId - when `undefined`, pop the jump stack, or,
+     * if the stack is empty, jump to last message.
      */
     jumpToMessage: this.scheduler.lockedQueuedEffect(
       'scroll',