From 29a7c6eca555402e6c7aacbf5f523ce4f3f4a5c4 Mon Sep 17 00:00:00 2001 From: mathieui Date: Sun, 11 Apr 2021 14:29:28 +0200 Subject: doc: explain module behavior --- poezio/log_loader.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/poezio/log_loader.py b/poezio/log_loader.py index edfaf90b..1e1d80b9 100644 --- a/poezio/log_loader.py +++ b/poezio/log_loader.py @@ -2,6 +2,18 @@ This modules contains a class that loads messages into a ChatTab, either from MAM or the local logs, and a class that loads MUC history into the local logs. + + +How the log loading works will depend on the poezio configuration: + +- if use_log is True, no logs will be fetched dynamically +- if use_log is False, all logs will be fetched from MAM (if available) +- if mam_sync and use_log are True, most chat tabs (all of them except the + static conversation tab) will try to sync the local + logs with the MAM history when opening them, or when joining a room. +- all log loading/writing workflows are paused until the MAM sync is complete + (so that the local log loading can be up-to-date with the MAM history) +- when use_log is False, mam_sync has no effect """ from __future__ import annotations import asyncio -- cgit v1.2.3