From 443b59c0a30ad55b2a218a51ca010c6e427905a5 Mon Sep 17 00:00:00 2001
From: jesopo <github@lolnerd.net>
Date: Mon, 11 Apr 2022 15:07:30 +0000
Subject: [PATCH] document ReportPoll.from

---
 src/report/ReportPoll.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/report/ReportPoll.ts b/src/report/ReportPoll.ts
index e1357ba..dd1a2b3 100644
--- a/src/report/ReportPoll.ts
+++ b/src/report/ReportPoll.ts
@@ -21,6 +21,10 @@ import { LogLevel } from "matrix-bot-sdk";
 class InvalidStateError extends Error {}
 
 export class ReportPoll {
+    /*
+     * https://matrix-org.github.io/synapse/latest/admin_api/event_reports.html
+     * "from" is an opaque token that is returned from the API to paginate reports
+     */
     private from = 0;
     private timeout: ReturnType<typeof setTimeout> | null = null;