From dc2493e7525bb7633f697ef10f72b72b46222249 Mon Sep 17 00:00:00 2001
From: Andy Belle-Isle <drumsetmonkey@gmail.com>
Date: Fri, 30 Aug 2019 00:45:36 -0400
Subject: Forget what I said, I just need to change git attributes to mark for
 vendor

---
 lib/sol2/docs/source/api/yielding.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 lib/sol2/docs/source/api/yielding.rst

(limited to 'lib/sol2/docs/source/api/yielding.rst')

diff --git a/lib/sol2/docs/source/api/yielding.rst b/lib/sol2/docs/source/api/yielding.rst
new file mode 100644
index 0000000..ad124b1
--- /dev/null
+++ b/lib/sol2/docs/source/api/yielding.rst
@@ -0,0 +1,10 @@
+yielding
+========
+*telling a C++ function to yield its results into Lua*
+
+.. code-block:: cpp
+
+	template <typename F>
+	yield_wrapper<F> yielding( F&& f )
+
+``sol::yielding`` is useful for calling C++ functions which need to yield into a Lua coroutine. It is a wrapper around a single argument which is expected to be bound as a function. You can pass it anywhere a regular function can be bound, **except for in usertype definitions**.
-- 
cgit v1.2.3