Started creating scripting library/namespace and added sol2 for interfacing

1 files changed, 11 insertions, 0 deletions

diff --git a/lib/sol2/docs/source/api/tie.rst b/lib/sol2/docs/source/api/tie.rst
new file mode 100644
index 0000000..946f7e6
--- /dev/null
+++ b/lib/sol2/docs/source/api/tie.rst
@@ -0,0 +1,11 @@
+tie
+===
+*improved version of std::tie*
+
+
+`std::tie()`_ does not work well with :doc:`sol::function<function>`'s ``sol::function_result`` returns. Use ``sol::tie`` instead. Because they're both named `tie`, you'll need to be explicit when you use sol's by naming it with the namespace (``sol::tie``), even with a ``using namespace sol;``. Here's an example:
+
+.. literalinclude:: ../../../examples/source/tie.cpp
+	:linenos:
+
+.. _std::tie(): http://en.cppreference.com/w/cpp/utility/tuple/tie