aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/tie.rst
diff options
context:
space:
mode:
authorAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:45:36 -0400
committerAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:45:36 -0400
commitdc2493e7525bb7633f697ef10f72b72b46222249 (patch)
tree9816755219e65d3f47fdce81c78f3736a7ddb8ab /lib/sol2/docs/source/api/tie.rst
parent9d2b31797d0cfd130802b69261df2cd402e39b49 (diff)
Forget what I said, I just need to change git attributes to mark for vendor
Diffstat (limited to 'lib/sol2/docs/source/api/tie.rst')
-rw-r--r--lib/sol2/docs/source/api/tie.rst11
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