From f41bdc4407e8780e55f8ee6d8719e1dad85b1f7f Mon Sep 17 00:00:00 2001
From: Anand Thakker <github@anandthakker.net>
Date: Tue, 12 Jun 2018 09:34:41 -0400
Subject: wip 1

---
 include/mbgl/actor/scheduler.hpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/include/mbgl/actor/scheduler.hpp b/include/mbgl/actor/scheduler.hpp
index d8a26ebeab..75ead29f0a 100644
--- a/include/mbgl/actor/scheduler.hpp
+++ b/include/mbgl/actor/scheduler.hpp
@@ -31,6 +31,11 @@ class Mailbox;
 class Scheduler {
 public:
     virtual ~Scheduler() = default;
+    
+    // Used by a Mailbox when it has a message in its queue to request that it
+    // be scheduled. Specifically, the scheduler is expected to asynchronously
+    // call `receive() on the given mailbox, provided it still exists at that
+    // time.
     virtual void schedule(std::weak_ptr<Mailbox>) = 0;
 
     // Set/Get the current Scheduler for this thread
-- 
cgit v1.2.1