Quick comment on DE to clarify use cases and lack of thread safety.

Summary: (Note: this ignores all push blocking failures!)

Reviewed By: yfeldblum

Differential Revision: D6212919

fbshipit-source-id: b066d99e13e97cbab489132bcb91872ed4407f81

diff --git a/folly/futures/Future-pre.h b/folly/futures/Future-pre.h
index 1fd0ebe70b5e40b0bb9181cc708399e9a988a5f5..26d9c7c6bb99316d4a0af3aa139267b845061ea6 100644 (file)
--- a/folly/futures/Future-pre.h
+++ b/folly/futures/Future-pre.h
@@ -155,6 +155,11 @@ struct Extract<R (&)(Args...)> {
 
 /**
  * Defer work until executor is actively boosted.
+ *
+ * NOTE: that this executor is a private implementation detail belonging to the
+ * Folly Futures library and not intended to be used elsewhere. It is designed
+ * specifically for the use case of deferring work on a SemiFuture. It is NOT
+ * thread safe. Please do not use for any other purpose without great care.
  */
 class DeferredExecutor final : public Executor {
  public: